Merge pull request #110 from sasjs/cli-issue-105

fix(context): fixed 'ContextAllAttributes' interface

src/SASViyaApiClient.ts

@@ -12,6 +12,7 @@ import {
   Job,
   Session,
   Context,
+  ContextAllAttributes,
   Folder,
   CsrfToken,
   EditContextInput,
@@ -224,16 +225,16 @@ export class SASViyaApiClient {
    * @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.
    * @param autoExecLines - the lines of code to execute during session initialization.
-   * @param authorizedUsers - an optional list of authorized user IDs.
    * @param accessToken - an access token for an authorized user.
+   * @param authorizedUsers - an optional list of authorized user IDs.
    */
   public async createContext(
     contextName: string,
     launchContextName: string,
     sharedAccountId: string,
     autoExecLines: string[],
-    authorizedUsers: string[],
-    accessToken?: string
+    accessToken?: string,
+    authorizedUsers?: string[]
   ) {
     if (!contextName) {
       throw new Error('Context name is required.')
@@ -313,10 +314,22 @@ export class SASViyaApiClient {
       headers.Authorization = `Bearer ${accessToken}`
     }
 
-    const originalContext = await this.getContextByName(
+    let originalContext
+
+    originalContext = await this.getComputeContextByName(
       contextName,
       accessToken
-    )
+    ).catch((_) => {})
+
+    // Try to find context by id, when context name has been changed.
+    if (!originalContext) {
+      originalContext = await this.getComputeContextById(
+        editedContext.id!,
+        accessToken
+      ).catch((err) => {
+        throw err
+      })
+    }
 
     const { result: context, etag } = await this.request<Context>(
       `${this.serverUrl}/compute/contexts/${originalContext.id}`,
@@ -372,7 +385,7 @@ export class SASViyaApiClient {
       headers.Authorization = `Bearer ${accessToken}`
     }
 
-    const context = await this.getContextByName(contextName, accessToken)
+    const context = await this.getComputeContextByName(contextName, accessToken)
 
     const deleteContextRequest: RequestInit = {
       method: 'DELETE',
@@ -932,7 +945,10 @@ export class SASViyaApiClient {
 
     if (isRelativePath(sasJob)) {
       const folderName = sasJob.split('/')[0]
-      await this.populateFolderMap(`${this.rootFolderName}/${folderName}`)
+      await this.populateFolderMap(
+        `${this.rootFolderName}/${folderName}`,
+        accessToken
+      )
 
       if (!this.folderMap.get(`${this.rootFolderName}/${folderName}`)) {
         throw new Error(
@@ -1029,7 +1045,10 @@ export class SASViyaApiClient {
 
     if (isRelativePath(sasJob)) {
       const folderName = sasJob.split('/')[0]
-      await this.populateFolderMap(`${this.rootFolderName}/${folderName}`)
+      await this.populateFolderMap(
+        `${this.rootFolderName}/${folderName}`,
+        accessToken
+      )
 
       if (!this.folderMap.get(`${this.rootFolderName}/${folderName}`)) {
         throw new Error(
@@ -1387,7 +1406,13 @@ export class SASViyaApiClient {
     return `/folders/folders/${folder.id}`
   }
 
-  private async getContextByName(
+  /**
+   * 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.
+   */
+  public async getComputeContextByName(
     contextName: string,
     accessToken?: string
   ): Promise<Context> {
@@ -1402,9 +1427,7 @@ export class SASViyaApiClient {
     const { result: contexts } = await this.request<{ items: Context[] }>(
       `${this.serverUrl}/compute/contexts?filter=eq(name, "${contextName}")`,
       { headers }
-    ).catch((err) => {
-      throw err
-    })
+    )
 
     if (!contexts || !(contexts.items && contexts.items.length)) {
       throw new Error(
@@ -1415,6 +1438,33 @@ export class SASViyaApiClient {
     return contexts.items[0]
   }
 
+  /**
+   * 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.
+   */
+  public async getComputeContextById(
+    contextId: string,
+    accessToken?: string
+  ): Promise<ContextAllAttributes> {
+    const headers: any = {
+      'Content-Type': 'application/json'
+    }
+
+    if (accessToken) {
+      headers.Authorization = `Bearer ${accessToken}`
+    }
+
+    const { result: context } = await this.request<ContextAllAttributes>(
+      `${this.serverUrl}/compute/contexts/${contextId}`,
+      { headers }
+    ).catch((err) => {
+      throw err
+    })
+
+    return context
+  }
+
   /**
    * Moves a Viya folder to a new location.  The folder may be renamed at the same time.
    * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder to be moved. Providing URI instead of path will save one extra request.

src/SASjs.ts

@@ -113,16 +113,16 @@ 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 authorizedUsers - an optional list of authorized user IDs.
    * @param accessToken - an access token for an authorized user.
+   * @param authorizedUsers - an optional list of authorized user IDs.
    */
   public async createContext(
     contextName: string,
     launchContextName: string,
     sharedAccountId: string,
     autoExecLines: string[],
-    authorizedUsers: string[],
-    accessToken: string
+    accessToken: string,
+    authorizedUsers?: string[]
   ) {
     this.isMethodSupported('createContext', ServerType.SASViya)
 
@@ -131,8 +131,8 @@ export default class SASjs {
       launchContextName,
       sharedAccountId,
       autoExecLines,
-      authorizedUsers,
-      accessToken
+      accessToken,
+      authorizedUsers
     )
   }
 
@@ -167,6 +167,38 @@ export default class SASjs {
     return await this.sasViyaApiClient!.deleteContext(contextName, accessToken)
   }
 
+  /**
+   * 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.
+   */
+  public async getComputeContextByName(
+    contextName: string,
+    accessToken?: string
+  ) {
+    this.isMethodSupported('getComputeContextByName', ServerType.SASViya)
+
+    return await this.sasViyaApiClient!.getComputeContextByName(
+      contextName,
+      accessToken
+    )
+  }
+
+  /**
+   * 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.
+   */
+  public async getComputeContextById(contextId: string, accessToken?: string) {
+    this.isMethodSupported('getComputeContextById', ServerType.SASViya)
+
+    return await this.sasViyaApiClient!.getComputeContextById(
+      contextId,
+      accessToken
+    )
+  }
+
   public async createSession(contextName: string, accessToken: string) {
     this.isMethodSupported('createSession', ServerType.SASViya)
 

src/types/Context.ts

@@ -14,4 +14,26 @@ export interface EditContextInput {
   attributes?: any
   authorizedUsers?: string[]
   authorizeAllAuthenticatedUsers?: boolean
+  id?: string
+}
+
+export interface ContextAllAttributes {
+  attributes: {
+    reuseServerProcesses: boolean
+    runServerAs: string
+  }
+  modifiedTimeStamp: string
+  createdBy: string
+  creationTimeStamp: string
+  launchType: string
+  environment: {
+    autoExecLines: [string]
+  }
+  launchContext: {
+    contextName: string
+  }
+  modifiedBy: string
+  id: string
+  version: number
+  name: string
 }