Merge pull request #865 from sasjs/viyaCreateFileAndPatch

Viya create file and patch

.github/workflows/server-tests.yml

@@ -79,14 +79,15 @@ jobs:
 
       - name: Deploy sasjs-tests
         run: |
-          npm install -g replace-in-files-cli
+          sudo apt install jq
           cd sasjs-tests
-          replace-in-files --regex='"@sasjs/adapter".*' --replacement='"@sasjs/adapter":"latest",' ./package.json
+          jq '.dependencies."@sasjs/adapter" |= "latest"' ./package.json > ./package.temp && mv ./package.temp ./package.json
           npm i
-          replace-in-files --regex='"serverUrl".*' --replacement='"serverUrl":"${{ secrets.SASJS_SERVER_URL }}",' ./public/config.json
+          jq '.sasJsConfig.serverUrl |= "${{ secrets.SASJS_SERVER_URL }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
-          replace-in-files --regex='"userName".*' --replacement='"userName":"${{ secrets.SASJS_USERNAME }}",' ./public/config.json
+          jq '.sasJsConfig.serverType |= "SASJS"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
-          replace-in-files --regex='"serverType".*' --replacement='"serverType":"SASJS",' ./public/config.json
+          jq '.userName |= "${{ secrets.SASJS_USERNAME }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
-          replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./public/config.json
+          jq '.password |= "${{ secrets.SASJS_PASSWORD }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
+
           cat ./public/config.json
 
           npm run update:adapter
@@ -98,9 +99,9 @@ jobs:
 
       - name: Run cypress on sasjs
         run: |
-          replace-in-files --regex='"sasjsTestsUrl".*' --replacement='"sasjsTestsUrl":"http://localhost:3000",' ./cypress.json
+          jq '.env.sasjsTestsUrl |= "http://localhost:3000"' ./cypress.json > ./cypress.temp && mv ./cypress.temp ./cypress.json
-          replace-in-files --regex='"username".*' --replacement='"username":"${{ secrets.SASJS_USERNAME }}",' ./cypress.json
+          jq '.env.username |= "${{ secrets.SASJS_USERNAME }}"' ./cypress.json > ./cypress.temp && mv ./cypress.temp ./cypress.json
-          replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./cypress.json
+          jq '.env.password |= "${{ secrets.SASJS_PASSWORD }}"' ./cypress.json > ./cypress.temp && mv ./cypress.temp ./cypress.json
           cat ./cypress.json
           echo "SASJS_USERNAME=${{ secrets.SASJS_USERNAME }}"
 

sasjs-tests/index.css

@@ -12,10 +12,6 @@ body {
   background: #f5f5f5;
 }
 
-#app {
-  min-height: 100vh;
-}
-
 .app__error {
   max-width: 800px;
   margin: 50px auto;

src/SASViyaApiClient.ts

@@ -35,7 +35,7 @@ interface JobExecutionResult {
   log?: string
   error?: object
 }
-
+/* Viya /types/types?limit=999999 response structure */
 interface IViyaTypesResponse {
   accept: string
   count: number
@@ -47,6 +47,7 @@ interface IViyaTypesResponse {
   version: number
 }
 
+/* Item element within the Viya types response */
 interface IViyaTypesItem {
   description?: string
   extensions?: string[]
@@ -56,7 +57,7 @@ interface IViyaTypesItem {
   mappedTypes?: string[]
   mediaType?: string
   mediaTypes?: string[]
-  name: string
+  name?: string | undefined
   pluralLabel?: string
   properties?: IViyaTypesProperties
   resourceUri?: string
@@ -70,18 +71,14 @@ interface IViyaTypesItem {
  * in the links array of a Viya
  * types/types api response
  */
-interface IViyaTypesLink {
+type IViyaTypesLink = Record<string, string>
-  [key: string]: string
-}
 
 /**
  * Generic structure for a type's
  * 'properties' object from the Viya
  * types/types api response
  */
-interface IViyaTypesProperties {
+type IViyaTypesProperties = Record<string, string>
-  [key: string]: string
-}
 
 /**
  * Arbitrary interface for storing
@@ -89,7 +86,7 @@ interface IViyaTypesProperties {
  * create and patch a new file.
  */
 interface IViyaTypesExtensionInfo {
-  typeDefName: string
+  typeDefName: string | undefined
   properties: IViyaTypesProperties | undefined
 }
 
@@ -118,9 +115,9 @@ export class SASViyaApiClient {
     this.requestClient
   )
   private folderMap = new Map<string, Job[]>()
-
   private fileExtensionMap = new Map<string, IViyaTypesExtensionInfo>()
-  private boolExtensionMap = false // has the fileExtensionMap been populated yet?
+  private boolExtensionMap = false // required in case the map has zero entries
+  // after an attempt to populate it.
 
   /**
    * A helper method used to call appendRequest method of RequestClient
@@ -494,17 +491,11 @@ export class SASViyaApiClient {
     const formData = new NodeFormData()
     formData.append('file', contentBuffer, fileName)
 
-    /** Query Viya for file metadata based on extension type.
+    /** Query Viya for file metadata based on extension type. */
-     *  Without providing certain properties, some versions of Viya will not
-     *  serve files as intended. Avoid this issue by applying the properties
-     *  that Viya has registered for a file extension.
-     */
 
-    // typeDefName - Viya should automatically determine this and additional
+    // typeDefName - Viya accepts this property during the file creation
-    // properties at runtime if not provided in the file creation request.
     let typeDefName: string | undefined = undefined
-    // Viya update 2025.09 resulted in a change to this automatic behaviour.
+    // Additional properties are supplied by a patch.
-    // We patch the new file to replicate the behaviour.
     let filePatch:
       | {
           name: string
@@ -533,7 +524,14 @@ export class SASViyaApiClient {
           .forEach((e) => {
             e.extensions?.forEach((ext) => {
               this.fileExtensionMap.set(ext, {
-                typeDefName: e.name, // "name:" is the typeDefName value required for file creation.
+                // `name` becomes the typeDefName value at file creation time.
+                // `name` is ignored here if it is not populated in the map, or
+                // has a blank/empty value.
+                typeDefName: e.name
+                  ? e.name.trim().length
+                    ? e.name.trim()
+                    : undefined
+                  : undefined,
                 properties: e.properties
               })
             })
@@ -542,17 +540,19 @@ export class SASViyaApiClient {
         this.boolExtensionMap = true
       }
 
+      // Query the map for the current file extension
       const fileExtInfo = this.fileExtensionMap.get(fileExtension)
       if (fileExtInfo) {
+        // If the extension was found in the map, record the typeDefName and
+        // create a patch if a properties object was returned.
         typeDefName = fileExtInfo.typeDefName
         if (fileExtInfo.properties)
           filePatch = { name: fileName, properties: fileExtInfo.properties }
       }
     }
 
-    return (
+    // Create the file
-      await this.requestClient
+    const createFileResponse = await this.requestClient.post<File>(
-        .post<File>(
       `/files/files?parentFolderUri=${parentFolderUri}&typeDefName=${
         typeDefName ?? 'file'
       }#rawUpload`,
@@ -561,23 +561,32 @@ export class SASViyaApiClient {
       'multipart/form-data; boundary=' + (formData as any)._boundary,
       headers
     )
-        .then(async (res) => {
+
     // If a patch was created...
     if (filePatch) {
+      try {
+        const patchHeaders = {
+          Accept: 'application/json',
+          'If-Match': '*'
+        }
         // Get the URI of the newly created file
-            const fileUri = res.result.links.filter(
+        const fileUri = createFileResponse.result.links.filter(
           (e) => e.method == 'PATCH' && e.rel == 'patch'
         )[0].uri
         // and apply the patch
-            return await this.requestClient.patch<File>(
+        return (
+          await this.requestClient.patch<File>(
             `${fileUri}`,
             filePatch,
-              accessToken
+            accessToken,
+            patchHeaders
           )
-          }
-          return res
-        })
         ).result
+      } catch (e: any) {
+        throw new Error(`Error patching file ${fileName}.\n${e.message}`)
+      }
+    }
+    return createFileResponse.result
   }
 
   /**

src/request/RequestClient.ts

@@ -273,9 +273,13 @@ export class RequestClient implements HttpClient {
   public async patch<T>(
     url: string,
     data: any = {},
-    accessToken?: string
+    accessToken?: string,
+    overrideHeaders: { [key: string]: string | number } = {}
   ): Promise<{ result: T; etag: string }> {
-    const headers = this.getHeaders(accessToken, 'application/json')
+    const headers = {
+      ...this.getHeaders(accessToken, 'application/json'),
+      ...overrideHeaders
+    }
 
     return this.httpClient
       .patch<T>(url, data, { headers, withXSRFToken: true })