Merge pull request #75 from sasjs/edit-context

feat(edit-context): add the ability to edit a given context

src/SASViyaApiClient.ts

@@ -8,7 +8,14 @@ import {
 } from './utils'
 import * as NodeFormData from 'form-data'
 import * as path from 'path'
-import { Job, Session, Context, Folder, CsrfToken } from './types'
+import {
+  Job,
+  Session,
+  Context,
+  Folder,
+  CsrfToken,
+  EditContextInput
+} from './types'
 import { JobDefinition } from './types/JobDefinition'
 import { formatDataForRequest } from './utils/formatDataForRequest'
 import { SessionManager } from './SessionManager'
@@ -267,6 +274,68 @@ export class SASViyaApiClient {
     return context
   }
 
+  /**
+   * Updates a compute context on the given server.
+   * @param contextId - the ID 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.
+   */
+  public async editContext(
+    contextId: string,
+    updatedContext: EditContextInput,
+    accessToken?: string
+  ) {
+    if (!contextId) {
+      throw new Error('Invalid context ID.')
+    }
+
+    const headers: any = {
+      'Content-Type': 'application/json'
+    }
+
+    if (accessToken) {
+      headers.Authorization = `Bearer ${accessToken}`
+    }
+
+    const { result: context, etag } = await this.request<Context>(
+      `${this.serverUrl}/compute/contexts/${contextId}`,
+      {
+        headers
+      }
+    ).catch((e) => {
+      console.error(e)
+
+      if (e && e.status === 404) {
+        throw new Error(
+          `The context with ID ${contextId} was not found on this server.`
+        )
+      }
+      throw new Error(
+        `An error occurred when fetching the context with ID ${contextId}`
+      )
+    })
+
+    // An If-Match header with the value of the last ETag for the context
+    // is required to be able to update it
+    // https://developer.sas.com/apis/rest/Compute/#update-a-context-definition
+    headers['If-Match'] = etag
+
+    const updateContextRequest: RequestInit = {
+      method: 'PUT',
+      headers,
+      body: JSON.stringify({
+        ...context,
+        ...updatedContext,
+        attributes: { ...context.attributes, ...updatedContext.attributes }
+      })
+    }
+
+    return await this.request<Context>(
+      `${this.serverUrl}/compute/contexts/${contextId}`,
+      updateContextRequest
+    )
+  }
+
   /**
    * Deletes a compute context on the given server.
    * @param contextId - the ID of the context to be deleted.

src/SASjs.ts

@@ -29,7 +29,8 @@ import {
   SASjsWaitingRequest,
   ServerType,
   CsrfToken,
-  UploadFile
+  UploadFile,
+  EditContextInput
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
@@ -137,6 +138,27 @@ export default class SASjs {
     )
   }
 
+  /**
+   * Updates a compute context on the given server.
+   * @param contextId - the ID 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.
+   */
+  public async editContext(
+    contextId: string,
+    editedContext: EditContextInput,
+    accessToken?: string
+  ) {
+    if (this.sasjsConfig.serverType !== ServerType.SASViya) {
+      throw new Error('This operation is only supported on SAS Viya servers.')
+    }
+    return await this.sasViyaApiClient!.editContext(
+      contextId,
+      editedContext,
+      accessToken
+    )
+  }
+
   /**
    * Deletes a compute context on the given server.
    * @param contextId - the ID of the context to be deleted.

src/SessionManager.ts

@@ -24,6 +24,7 @@ export class SessionManager {
       (new Date().getTime() - new Date(session!.creationTimeStamp).getTime()) /
       1000
     if (
+      !session!.attributes ||
       secondsSinceSessionCreation >= session!.attributes.sessionInactiveTimeout
     ) {
       await this.createSessions(accessToken)

src/types/Context.ts

@@ -3,4 +3,15 @@ export interface Context {
   id: string
   createdBy: string
   version: number
+  attributes?: any
+}
+
+export interface EditContextInput {
+  name?: string
+  description?: string
+  launchContext?: { name: string }
+  environment?: { options?: string[]; autoExecLines?: string[] }
+  attributes?: any
+  authorizedUsers?: string[]
+  authorizeAllAuthenticatedUsers?: boolean
 }

src/utils/parseGeneratedCode.spec.ts

@@ -1,34 +1,21 @@
-import SASjs from './index'
+import { parseGeneratedCode } from './index'
-
-const adapter = new SASjs()
-
-it('should parse SAS9 source code', async (done) => {
-  expect(sampleResponse).toBeTruthy()
-  const parsedSourceCode = (adapter as any).parseSAS9SourceCode(sampleResponse)
-  expect(parsedSourceCode).toBeTruthy()
-  const sourceCodeLines = parsedSourceCode.split('\r\n')
-  expect(sourceCodeLines.length).toEqual(5)
-  expect(sourceCodeLines[0].startsWith('6')).toBeTruthy()
-  expect(sourceCodeLines[1].startsWith('7')).toBeTruthy()
-  expect(sourceCodeLines[2].startsWith('8')).toBeTruthy()
-  expect(sourceCodeLines[3].startsWith('9')).toBeTruthy()
-  expect(sourceCodeLines[4].startsWith('10')).toBeTruthy()
-  done()
-})
 
 it('should parse generated code', async (done) => {
   expect(sampleResponse).toBeTruthy()
-  const parsedGeneratedCode = (adapter as any).parseGeneratedCode(
+
-    sampleResponse
+  const parsedGeneratedCode = parseGeneratedCode(sampleResponse)
-  )
+
   expect(parsedGeneratedCode).toBeTruthy()
+
   const generatedCodeLines = parsedGeneratedCode.split('\r\n')
+
   expect(generatedCodeLines.length).toEqual(5)
   expect(generatedCodeLines[0].startsWith('MPRINT(MM_WEBIN)')).toBeTruthy()
   expect(generatedCodeLines[1].startsWith('MPRINT(MM_WEBLEFT)')).toBeTruthy()
   expect(generatedCodeLines[2].startsWith('MPRINT(MM_WEBOUT)')).toBeTruthy()
   expect(generatedCodeLines[3].startsWith('MPRINT(MM_WEBRIGHT)')).toBeTruthy()
   expect(generatedCodeLines[4].startsWith('MPRINT(MM_WEBOUT)')).toBeTruthy()
+
   done()
 })
 

src/utils/parseSourceCode.spec.ts

@@ -0,0 +1,35 @@
+import { parseSourceCode } from './index'
+
+it('should parse SAS9 source code', async (done) => {
+  expect(sampleResponse).toBeTruthy()
+
+  const parsedSourceCode = parseSourceCode(sampleResponse)
+
+  expect(parsedSourceCode).toBeTruthy()
+
+  const sourceCodeLines = parsedSourceCode.split('\r\n')
+
+  expect(sourceCodeLines.length).toEqual(5)
+  expect(sourceCodeLines[0].startsWith('6')).toBeTruthy()
+  expect(sourceCodeLines[1].startsWith('7')).toBeTruthy()
+  expect(sourceCodeLines[2].startsWith('8')).toBeTruthy()
+  expect(sourceCodeLines[3].startsWith('9')).toBeTruthy()
+  expect(sourceCodeLines[4].startsWith('10')).toBeTruthy()
+
+  done()
+})
+
+/* tslint:disable */
+const sampleResponse = `<meta http-equiv="Content-Type" content="text/html; charset=windows-1252"/>
+6          @file mm_webout.sas
+7          @brief Send data to/from SAS Stored Processes
+8          @details This macro should be added to the start of each Stored Process,
+9          **immediately** followed by a call to:
+10         %webout(OPEN)
+MPRINT(MM_WEBIN):  ;
+MPRINT(MM_WEBLEFT):   filename _temp temp lrecl=999999;
+MPRINT(MM_WEBOUT):   data _null_;
+MPRINT(MM_WEBRIGHT):  file _temp;
+MPRINT(MM_WEBOUT):   if upcase(symget('_debug'))='LOG' then put '&gt;&gt;weboutBEGIN&lt;&lt;';
+`
+/* tslint:enable */