Merge pull request #690 from sasjs/issue-689

fix: update code for extracting JSON URL on viya4 when debug is enabled

package-lock.json

@@ -8,7 +8,7 @@
       "hasInstallScript": true,
       "license": "ISC",
       "dependencies": {
-        "@sasjs/utils": "2.36.1",
+        "@sasjs/utils": "2.42.0",
         "axios": "0.26.0",
         "axios-cookiejar-support": "1.0.1",
         "form-data": "4.0.0",
@@ -1142,9 +1142,9 @@
       }
     },
     "node_modules/@sasjs/utils": {
-      "version": "2.36.1",
-      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.36.1.tgz",
-      "integrity": "sha512-JkGUpLOODsvkeU+S25jb9k2WnvzyD2w6cEk7YyQ/byuqKL8xawH91PPWegrVcJlDY8WmqKE4CPcA3d1mM3B3LA==",
+      "version": "2.42.0",
+      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.42.0.tgz",
+      "integrity": "sha512-Y69l89PYNF/h9xvVH72om/39xA+cY80bhiVLzp/fJb3BlvzCf4RNswBBanUOv2I5JNa7gPpJuE7mEiXOlhD3eg==",
       "hasInstallScript": true,
       "dependencies": {
         "@types/fs-extra": "9.0.13",
@@ -13870,9 +13870,9 @@
       }
     },
     "@sasjs/utils": {
-      "version": "2.36.1",
-      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.36.1.tgz",
-      "integrity": "sha512-JkGUpLOODsvkeU+S25jb9k2WnvzyD2w6cEk7YyQ/byuqKL8xawH91PPWegrVcJlDY8WmqKE4CPcA3d1mM3B3LA==",
+      "version": "2.42.0",
+      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.42.0.tgz",
+      "integrity": "sha512-Y69l89PYNF/h9xvVH72om/39xA+cY80bhiVLzp/fJb3BlvzCf4RNswBBanUOv2I5JNa7gPpJuE7mEiXOlhD3eg==",
       "requires": {
         "@types/fs-extra": "9.0.13",
         "@types/prompts": "2.0.13",

package.json

@@ -72,7 +72,7 @@
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "2.36.1",
+    "@sasjs/utils": "2.42.0",
     "axios": "0.26.0",
     "axios-cookiejar-support": "1.0.1",
     "form-data": "4.0.0",

src/SASjs.ts

@@ -5,8 +5,7 @@ import {
   EditContextInput,
   PollOptions,
   LoginMechanism,
-  ExecutionQuery,
-  FileTree
+  ExecutionQuery
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
@@ -17,7 +16,8 @@ import {
   MacroVar,
   AuthConfig,
   ExtraResponseAttributes,
-  SasAuthResponse
+  SasAuthResponse,
+  ServicePackSASjs
 } from '@sasjs/utils/types'
 import { RequestClient } from './request/RequestClient'
 import { SasjsRequestClient } from './request/SasjsRequestClient'
@@ -134,7 +134,7 @@ export default class SASjs {
 
   /**
    * Gets compute contexts.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async getComputeContexts(accessToken: string) {
     this.isMethodSupported('getComputeContexts', [ServerType.SasViya])
@@ -144,7 +144,7 @@ export default class SASjs {
 
   /**
    * Gets launcher contexts.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async getLauncherContexts(accessToken: string) {
     this.isMethodSupported('getLauncherContexts', [ServerType.SasViya])
@@ -163,7 +163,7 @@ export default class SASjs {
 
   /**
    * Gets executable compute contexts.
-   * @param authConfig - an access token, refresh token, client and secret for an authorized user.
+   * @param authConfig - an access token, refresh token, client and secret for an authorised user.
    */
   public async getExecutableContexts(authConfig: AuthConfig) {
     this.isMethodSupported('getExecutableContexts', [ServerType.SasViya])
@@ -177,8 +177,8 @@ export default class SASjs {
    * @param launchContextName - the name of the launcher context used by the compute service.
    * @param sharedAccountId - the ID of the account to run the servers for this context as.
    * @param autoExecLines - the lines of code to execute during session initialization.
-   * @param accessToken - an access token for an authorized user.
-   * @param authorizedUsers - an optional list of authorized user IDs.
+   * @param accessToken - an access token for an authorised user.
+   * @param authorisedUsers - an optional list of authorised user IDs.
    */
   public async createComputeContext(
     contextName: string,
@@ -186,7 +186,7 @@ export default class SASjs {
     sharedAccountId: string,
     autoExecLines: string[],
     accessToken: string,
-    authorizedUsers?: string[]
+    authorisedUsers?: string[]
   ) {
     this.isMethodSupported('createComputeContext', [ServerType.SasViya])
 
@@ -196,7 +196,7 @@ export default class SASjs {
       sharedAccountId,
       autoExecLines,
       accessToken,
-      authorizedUsers
+      authorisedUsers
     )
   }
 
@@ -205,7 +205,7 @@ export default class SASjs {
    * @param contextName - the name of the context to be created.
    * @param description - the description of the context to be created.
    * @param launchType - launch type of the context to be created.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async createLauncherContext(
     contextName: string,
@@ -227,7 +227,7 @@ export default class SASjs {
    * Updates a compute context on the given server.
    * @param contextName - the original name of the context to be deleted.
    * @param editedContext - an object with the properties to be updated.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async editComputeContext(
     contextName: string,
@@ -246,7 +246,7 @@ export default class SASjs {
   /**
    * Deletes a compute context on the given server.
    * @param contextName - the name of the context to be deleted.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async deleteComputeContext(contextName: string, accessToken?: string) {
     this.isMethodSupported('deleteComputeContext', [ServerType.SasViya])
@@ -261,7 +261,7 @@ export default class SASjs {
    * Returns a JSON representation of a compute context.
    * @example: { "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }
    * @param contextName - the name of the context to return.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async getComputeContextByName(
     contextName: string,
@@ -278,7 +278,7 @@ export default class SASjs {
   /**
    * Returns a JSON representation of a compute context.
    * @param contextId - an id of the context to return.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async getComputeContextById(contextId: string, accessToken?: string) {
     this.isMethodSupported('getComputeContextById', [ServerType.SasViya])
@@ -888,20 +888,21 @@ export default class SASjs {
 
   /**
    * Creates the folders and services at the given location `appLoc` on the given server `serverUrl`.
-   * @param members - the JSON specifying the folders and services to be created.
-   * @param appLoc - the base folder in which to create the new folders and
-   * services.  If not provided, is taken from SASjsConfig.
-   * @param authConfig - a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
+   * @param dataJson - the JSON specifying the folders and files to be created, can also includes
+   * appLoc, streamServiceName, streamWebFolder, streamLogo
+   * @param appLoc - (optional) the base folder in which to create the new folders and
+   * services.  If not provided, is taken from SASjsConfig. Precedence will be of appLoc present in dataJson.
+   * @param authConfig - (optional) a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
    */
   public async deployToSASjs(
-    members: FileTree,
+    dataJson: ServicePackSASjs,
     appLoc?: string,
     authConfig?: AuthConfig
   ) {
     if (!appLoc) {
       appLoc = this.sasjsConfig.appLoc
     }
-    return await this.sasJSApiClient?.deploy(members, appLoc, authConfig)
+    return await this.sasJSApiClient?.deploy(dataJson, appLoc, authConfig)
   }
 
   public async executeJobSASjs(query: ExecutionQuery) {
@@ -972,7 +973,7 @@ export default class SASjs {
   /**
    * Fetches content of the log file
    * @param logUrl - url of the log file.
-   * @param accessToken - an access token for an authorized user.
+   * @param accessToken - an access token for an authorised user.
    */
   public async fetchLogFileContent(logUrl: string, accessToken?: string) {
     return await this.requestClient!.get(logUrl, accessToken).then((res) => {
@@ -1094,13 +1095,8 @@ export default class SASjs {
     }
 
     if (this.sasjsConfig.serverType === ServerType.Sasjs) {
-      if (this.sasJSApiClient) {
-        this.sasJSApiClient.setConfig(this.sasjsConfig.serverUrl)
-      } else {
-        this.sasJSApiClient = new SASjsApiClient(
-          this.sasjsConfig.serverUrl,
-          this.requestClient
-        )
+      if (!this.sasJSApiClient) {
+        this.sasJSApiClient = new SASjsApiClient(this.requestClient)
       }
     }
 

src/SASjsApiClient.ts

@@ -1,5 +1,5 @@
-import { AuthConfig, ServerType } from '@sasjs/utils/types'
-import { FileTree, ExecutionQuery } from './types'
+import { AuthConfig, ServerType, ServicePackSASjs } from '@sasjs/utils/types'
+import { ExecutionQuery } from './types'
 import { RequestClient } from './request/RequestClient'
 import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs'
 import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs'
@@ -8,17 +8,10 @@ import { parseWeboutResponse } from './utils'
 import { getTokens } from './auth/getTokens'
 
 export class SASjsApiClient {
-  constructor(
-    private serverUrl: string,
-    private requestClient: RequestClient
-  ) {}
-
-  public setConfig(serverUrl: string) {
-    if (serverUrl) this.serverUrl = serverUrl
-  }
+  constructor(private requestClient: RequestClient) {}
 
   public async deploy(
-    members: FileTree,
+    dataJson: ServicePackSASjs,
     appLoc: string,
     authConfig?: AuthConfig
   ) {
@@ -30,13 +23,17 @@ export class SASjsApiClient {
         ServerType.Sasjs
       ))
     }
+
+    dataJson.appLoc = dataJson.appLoc || appLoc
+
     const { result } = await this.requestClient.post<{
       status: string
       message: string
+      streamServiceName?: string
       example?: {}
     }>(
       'SASjsApi/drive/deploy',
-      { fileTree: members, appLoc: appLoc },
+      dataJson,
       access_token,
       undefined,
       {},

src/file/generateFileUploadForm.ts

@@ -26,11 +26,18 @@ export const generateFileUploadForm = (
       )
     }
 
-    const file = new Blob([csv], {
-      type: 'application/csv'
-    })
+    if (typeof FormData === 'undefined' && formData instanceof NodeFormData) {
+      formData.append(name, csv, {
+        filename: `${name}.csv`,
+        contentType: 'application/csv'
+      })
+    } else {
+      const file = new Blob([csv], {
+        type: 'application/csv'
+      })
 
-    formData.append(name, file, `${name}.csv`)
+      formData.append(name, file, `${name}.csv`)
+    }
   }
 
   return formData

src/types/FileTree.ts

@@ -1,47 +0,0 @@
-export interface FileTree {
-  members: [FolderMember, ServiceMember]
-}
-
-export enum MemberType {
-  folder = 'folder',
-  service = 'service'
-}
-
-export interface FolderMember {
-  name: string
-  type: MemberType.folder
-  members: [FolderMember, ServiceMember]
-}
-
-export interface ServiceMember {
-  name: string
-  type: MemberType.service
-  code: string
-}
-
-export const isFileTree = (arg: any): arg is FileTree =>
-  arg &&
-  arg.members &&
-  Array.isArray(arg.members) &&
-  arg.members.filter(
-    (member: FolderMember | ServiceMember) =>
-      !isFolderMember(member) && !isServiceMember(member)
-  ).length === 0
-
-const isFolderMember = (arg: any): arg is FolderMember =>
-  arg &&
-  typeof arg.name === 'string' &&
-  arg.type === MemberType.folder &&
-  arg.members &&
-  Array.isArray(arg.members) &&
-  arg.members.filter(
-    (member: FolderMember | ServiceMember) =>
-      !isFolderMember(member) && !isServiceMember(member)
-  ).length === 0
-
-const isServiceMember = (arg: any): arg is ServiceMember =>
-  arg &&
-  typeof arg.name === 'string' &&
-  arg.type === MemberType.service &&
-  arg.code &&
-  typeof arg.code === 'string'

src/types/index.ts

@@ -12,5 +12,4 @@ export * from './Session'
 export * from './UploadFile'
 export * from './PollOptions'
 export * from './WriteStream'
-export * from './FileTree'
 export * from './ExecuteScript'

src/utils/parseViyaDebugResponse.ts

@@ -16,10 +16,15 @@ export const parseSasViyaDebugResponse = async (
   requestClient: RequestClient,
   serverUrl: string
 ) => {
+  // On viya 3.5, iframe is like <iframe style="width: 99%; height: 500px" src="..."></iframe>
+  // On viya 4, iframe is like <iframe style="width: 99%; height: 500px; background-color:Canvas;" src=...></iframe>
+
   const iframeStart = response.split(
-    '<iframe style="width: 99%; height: 500px" src="'
+    /<iframe style="width: 99%; height: 500px" src="|<iframe style="width: 99%; height: 500px; background-color:Canvas;" src=/
   )[1]
-  const jsonUrl = iframeStart ? iframeStart.split('"></iframe>')[0] : null
+  const jsonUrl = iframeStart
+    ? iframeStart.split(/"><\/iframe>|><\/iframe>/)[0]
+    : null
   if (!jsonUrl) {
     throw new Error('Unable to find webout file URL.')
   }