Merge pull request #865 from sasjs/viyaCreateFileAndPatch

Viya create file and patch
fix: defensively coded for potential empty 'name' properties in the viya types response
2026-01-05 19:50:06 +00:00 · 2025-11-25 09:02:48 +00:00 · 2025-11-25 07:39:00 +00:00 · 2025-11-23 06:29:52 +00:00 · 2025-11-22 22:19:34 +00:00 · 2025-11-22 22:11:55 +00:00
7 changed files with 183 additions and 218 deletions
--- a/.github/workflows/server-tests.yml
+++ b/.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 }}"
--- a/sasjs-tests/src/main.ts
+++ b/sasjs-tests/src/main.ts
@@ -22,7 +22,6 @@ import { sendArrTests, sendObjTests } from './testSuites/RequestData'
 import { fileUploadTests } from './testSuites/FileUpload'
 import { computeTests } from './testSuites/Compute'
 import { sasjsRequestTests } from './testSuites/SasjsRequests'
 import { viyaFileTests } from './testSuites/ViyaFile'
 async function init() {
  const appContainer = document.getElementById('app')
@@ -104,10 +103,9 @@ function showTests(
    fileUploadTests(adapter)
  ]
-  // Add certain tests for SASVIYA only
+  // Add compute tests for SASVIYA only
  if (adapter.getSasjsConfig().serverType === 'SASVIYA') {
    testSuites.push(computeTests(adapter, appLoc))
    testSuites.push(viyaFileTests(adapter, appLoc))
  }
  container.innerHTML = ''
--- a/sasjs-tests/src/testSuites/ViyaFile.ts
+++ b/sasjs-tests/src/testSuites/ViyaFile.ts
@@ -1,31 +0,0 @@
 import SASjs from '@sasjs/adapter'
 import type { TestSuite } from '../types'
 export const viyaFileTests = (adapter: SASjs, appLoc: string): TestSuite => ({
  name: 'SAS Viya File Tests',
  tests: [
    {
      title: 'Create html file',
      description: 'Should create an html file with appropriate properties',
      test: async () => {
        const fileContentBuffer = Buffer.from(
          `<html>` +
            `  <head><title>Test</title></head>` +
            `  <body><p>This is a test</p></body>` +
            `</html>`
        )
        // generate a timestamp string formatted as YYYYmmDDTHHMMSS_999
        const timeMark = new Date()
          .toISOString()
          .replace(/(\/|:|\s|-|Z)/g, '')
          .replace(/\./g, '_')
        const filename = `viya_createFile_test_${timeMark}.html`
        return adapter.createFile(filename, fileContentBuffer, appLoc)
      },
      assertion: () => {
        //A test that returns a boolean
        return true // dummy
      }
    }
  ]
 })
--- a/sasjs-tests/vite.config.js
+++ b/sasjs-tests/vite.config.js
@@ -1,12 +1,5 @@
 import { defineConfig } from 'vite'
 import { nodePolyfills } from 'vite-plugin-node-polyfills'
 export default defineConfig({
  plugins: [
    nodePolyfills({
      include: ['buffer']
    })
  ],
  build: {
    assetsInlineLimit: 0,
    assetsDir: ''
--- a/src/SASViyaApiClient.ts
+++ b/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
@@ -85,7 +86,7 @@ type IViyaTypesProperties = Record<string, string>
 * create and patch a new file.
 */
 interface IViyaTypesExtensionInfo {
-  typeDefName: string
+  typeDefName: string | undefined
  properties: IViyaTypesProperties | undefined
 }
@@ -114,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
@@ -481,29 +482,20 @@ export class SASViyaApiClient {
    if (!parentFolderUri && parentFolderPath) {
      parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken)
    }
    const headers = {
      Accept: 'application/vnd.sas.file+json',
      'Content-Disposition': `filename="${fileName}";`
    }
    const patchHeaders = {
      Accept: 'application/json',
      'If-Match': '*'
    }
    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
@@ -532,8 +524,14 @@ export class SASViyaApiClient {
          .forEach((e) => {
            e.extensions?.forEach((ext) => {
              this.fileExtensionMap.set(ext, {
-                // "name:" is the typeDefName value required for file creation.
+                // `name` becomes the typeDefName value at file creation time.
-                typeDefName: e.name,
+                // `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,14 +540,18 @@ 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 }
      }
    }
    // Create the file
    const createFileResponse = await this.requestClient.post<File>(
      `/files/files?parentFolderUri=${parentFolderUri}&typeDefName=${
        typeDefName ?? 'file'
@@ -560,9 +562,13 @@ export class SASViyaApiClient {
      headers
    )
    try {
    // 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 = createFileResponse.result.links.filter(
          (e) => e.method == 'PATCH' && e.rel == 'patch'
@@ -573,16 +579,15 @@ export class SASViyaApiClient {
            `${fileUri}`,
            filePatch,
            accessToken,
            'application/json',
            patchHeaders
          )
        ).result
      }
      return createFileResponse.result
      } catch (e: any) {
        throw new Error(`Error patching file ${fileName}.\n${e.message}`)
      }
    }
    return createFileResponse.result
  }
  /**
   * Creates a folder. Path to or URI of the parent folder is required.
--- a/src/request/RequestClient.ts
+++ b/src/request/RequestClient.ts
@@ -272,13 +272,12 @@ export class RequestClient implements HttpClient {
  public async patch<T>(
    url: string,
-    data: any,
+    data: any = {},
-    accessToken: string | undefined,
+    accessToken?: string,
    contentType = 'application/json',
    overrideHeaders: { [key: string]: string | number } = {}
  ): Promise<{ result: T; etag: string }> {
    const headers = {
-      ...this.getHeaders(accessToken, contentType),
+      ...this.getHeaders(accessToken, 'application/json'),
      ...overrideHeaders
    }
Author	SHA1	Message	Date
Allan Bowe	03b7592521	Merge pull request #865 from sasjs/viyaCreateFileAndPatch Viya create file and patch	2025-11-25 09:02:48 +00:00
Trevor Moody	ba64ed1f20	fix: defensively coded for potential empty 'name' properties in the viya types response	2025-11-25 07:39:00 +00:00
Trevor Moody	480510b980	build: (server-tests) use jq to safely modify json	2025-11-23 06:29:52 +00:00
Trevor Moody	8c7767a36d	fix: (build) command syntax	2025-11-22 22:19:34 +00:00
Trevor Moody	f335be344e	build: adjusted search/replace regex/value to allow for json lines without trailing commas	2025-11-22 22:11:55 +00:00
Trevor Moody	680f5a4872	chore: (sasjs-tests) prevent redundant rendering of vertical scroll bar	2025-11-22 17:58:00 +00:00
Trevor Moody	c42a20a8ee	feat: (viya) apply properties to newly created files	2025-11-22 17:56:50 +00:00