chore: tidied up branch

.github/workflows/server-tests.yml

@@ -1,108 +1,107 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: SASjs Build and Server Tests
-
-on:
-  pull_request:
-
-jobs:
-  test:
-    runs-on: ubuntu-22.04
-
-    strategy:
-      matrix:
-        node-version: [lts/hydrogen]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      # 2. Restore npm cache manually
-      - name: Restore npm cache
-        uses: actions/cache@v3
-        id: npm-cache
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Install Dependencies
-        run: npm ci
-
-      - name: Install Rimraf
-        run: npm i rimraf
-
-      - name: Build Package
-        run: npm run package:lib
-        env:
-          CI: true
-
-      - name: Write VPN Files
-        run: |
-          echo "$CA_CRT" > .github/vpn/ca.crt
-          echo "$USER_CRT" > .github/vpn/user.crt
-          echo "$USER_KEY" > .github/vpn/user.key
-          echo "$TLS_KEY" > .github/vpn/tls.key
-        shell: bash
-        env:
-          CA_CRT: ${{ secrets.CA_CRT}}
-          USER_CRT: ${{ secrets.USER_CRT }}
-          USER_KEY: ${{ secrets.USER_KEY }}
-          TLS_KEY: ${{ secrets.TLS_KEY }}
-
-      - name: Chmod VPN files
-        run: |
-          chmod 600 .github/vpn/ca.crt .github/vpn/user.crt .github/vpn/user.key .github/vpn/tls.key
-
-      - name: Install Open VPN
-        run: |
-          sudo apt install apt-transport-https
-          sudo wget https://swupdate.openvpn.net/repos/openvpn-repo-pkg-key.pub
-          sudo apt-key add openvpn-repo-pkg-key.pub
-          sudo wget -O /etc/apt/sources.list.d/openvpn3.list https://swupdate.openvpn.net/community/openvpn3/repos/openvpn3-jammy.list
-          sudo apt update
-          sudo apt install openvpn3=17~betaUb22042+jammy
-
-      - name: Start Open VPN 3
-        run: openvpn3 session-start --config .github/vpn/config.ovpn
-
-      - name: install pm2
-        run: npm i -g pm2
-
-      - name: Fetch SASJS server
-        run: curl ${{ secrets.SASJS_SERVER_URL }}/SASjsApi/info
-
-      - name: Deploy sasjs-tests
-        run: |
-          sudo apt install jq
-          cd sasjs-tests
-          jq '.dependencies."@sasjs/adapter" |= "latest"' ./package.json > ./package.temp && mv ./package.temp ./package.json
-          npm i
-          jq '.sasJsConfig.serverUrl |= "${{ secrets.SASJS_SERVER_URL }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
-          jq '.sasJsConfig.serverType |= "SASJS"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./public/config.json
-          jq '.userName |= "${{ secrets.SASJS_USERNAME }}"' ./public/config.json > ./public/config.temp && mv ./public/config.temp ./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
-          pm2 start --name sasjs-test npm -- start
-
-      - name: Sleep for 10 seconds
-        run: sleep 10s
-        shell: bash
-
-      - name: Run cypress on sasjs
-        run: |
-          jq '.env.sasjsTestsUrl |= "http://localhost:3000"' ./cypress.json > ./cypress.temp && mv ./cypress.temp ./cypress.json
-          jq '.env.username |= "${{ secrets.SASJS_USERNAME }}"' ./cypress.json > ./cypress.temp && mv ./cypress.temp ./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 }}"
-
-          sh ./sasjs-tests/sasjs-cypress-run.sh ${{ secrets.MATRIX_TOKEN }} https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: SASjs Build and Server Tests
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      matrix:
+        node-version: [lts/hydrogen]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      # 2. Restore npm cache manually
+      - name: Restore npm cache
+        uses: actions/cache@v3
+        id: npm-cache
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Install Rimraf
+        run: npm i rimraf
+
+      - name: Build Package
+        run: npm run package:lib
+        env:
+          CI: true
+
+      - name: Write VPN Files
+        run: |
+          echo "$CA_CRT" > .github/vpn/ca.crt
+          echo "$USER_CRT" > .github/vpn/user.crt
+          echo "$USER_KEY" > .github/vpn/user.key
+          echo "$TLS_KEY" > .github/vpn/tls.key
+        shell: bash
+        env:
+          CA_CRT: ${{ secrets.CA_CRT}}
+          USER_CRT: ${{ secrets.USER_CRT }}
+          USER_KEY: ${{ secrets.USER_KEY }}
+          TLS_KEY: ${{ secrets.TLS_KEY }}
+
+      - name: Chmod VPN files
+        run: |
+          chmod 600 .github/vpn/ca.crt .github/vpn/user.crt .github/vpn/user.key .github/vpn/tls.key
+
+      - name: Install Open VPN
+        run: |
+          sudo apt install apt-transport-https
+          sudo wget https://swupdate.openvpn.net/repos/openvpn-repo-pkg-key.pub
+          sudo apt-key add openvpn-repo-pkg-key.pub
+          sudo wget -O /etc/apt/sources.list.d/openvpn3.list https://swupdate.openvpn.net/community/openvpn3/repos/openvpn3-jammy.list
+          sudo apt update
+          sudo apt install openvpn3=17~betaUb22042+jammy
+
+      - name: Start Open VPN 3
+        run: openvpn3 session-start --config .github/vpn/config.ovpn
+
+      - name: install pm2
+        run: npm i -g pm2
+
+      - name: Fetch SASJS server
+        run: curl ${{ secrets.SASJS_SERVER_URL }}/SASjsApi/info
+
+      - name: Deploy sasjs-tests
+        run: |
+          npm install -g replace-in-files-cli
+          cd sasjs-tests
+          replace-in-files --regex='"@sasjs/adapter".*' --replacement='"@sasjs/adapter":"latest",' ./package.json
+          npm i
+          replace-in-files --regex='"serverUrl".*' --replacement='"serverUrl":"${{ secrets.SASJS_SERVER_URL }}",' ./public/config.json
+          replace-in-files --regex='"userName".*' --replacement='"userName":"${{ secrets.SASJS_USERNAME }}",' ./public/config.json
+          replace-in-files --regex='"serverType".*' --replacement='"serverType":"SASJS",' ./public/config.json
+          replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./public/config.json
+          cat ./public/config.json
+
+          npm run update:adapter
+          pm2 start --name sasjs-test npm -- start
+
+      - name: Sleep for 10 seconds
+        run: sleep 10s
+        shell: bash
+
+      - name: Run cypress on sasjs
+        run: |
+          replace-in-files --regex='"sasjsTestsUrl".*' --replacement='"sasjsTestsUrl":"http://localhost:3000",' ./cypress.json
+          replace-in-files --regex='"username".*' --replacement='"username":"${{ secrets.SASJS_USERNAME }}",' ./cypress.json
+          replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./cypress.json
+          cat ./cypress.json
+          echo "SASJS_USERNAME=${{ secrets.SASJS_USERNAME }}"
+
+          sh ./sasjs-tests/sasjs-cypress-run.sh ${{ secrets.MATRIX_TOKEN }} https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}

sasjs-tests/index.css

@@ -1,39 +1,39 @@
-* {
-  box-sizing: border-box;
-  margin: 0;
-  padding: 0;
-}
-
-body {
-  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
-    Ubuntu, Cantarell, sans-serif;
-  line-height: 1.6;
-  color: #333;
-  background: #f5f5f5;
-}
-
-.app__error {
-  max-width: 800px;
-  margin: 50px auto;
-  padding: 30px;
-  background: white;
-  border-radius: 8px;
-  box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
-
-  h1 {
-    color: #e74c3c;
-    margin-bottom: 15px;
-  }
-
-  p {
-    margin-bottom: 15px;
-  }
-
-  pre {
-    background: #2c3e50;
-    color: #ecf0f1;
-    padding: 15px;
-    border-radius: 4px;
-    overflow-x: auto;
-  }
-}
+* {
+  box-sizing: border-box;
+  margin: 0;
+  padding: 0;
+}
+
+body {
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
+    Ubuntu, Cantarell, sans-serif;
+  line-height: 1.6;
+  color: #333;
+  background: #f5f5f5;
+}
+
+.app__error {
+  max-width: 800px;
+  margin: 50px auto;
+  padding: 30px;
+  background: white;
+  border-radius: 8px;
+  box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
+
+  h1 {
+    color: #e74c3c;
+    margin-bottom: 15px;
+  }
+
+  p {
+    margin-bottom: 15px;
+  }
+
+  pre {
+    background: #2c3e50;
+    color: #ecf0f1;
+    padding: 15px;
+    border-radius: 4px;
+    overflow-x: auto;
+  }
+}

sasjs-tests/src/main.ts

@@ -22,6 +22,7 @@ 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')
@@ -103,9 +104,10 @@ function showTests(
     fileUploadTests(adapter)
   ]
 
-  // Add compute tests for SASVIYA only
+  // Add certain tests for SASVIYA only
   if (adapter.getSasjsConfig().serverType === 'SASVIYA') {
     testSuites.push(computeTests(adapter, appLoc))
+    testSuites.push(viyaFileTests(adapter, appLoc))
   }
 
   container.innerHTML = ''

sasjs-tests/src/testSuites/ViyaFile.ts

@@ -0,0 +1,31 @@
+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
+      }
+    }
+  ]
+})

sasjs-tests/vite.config.js

@@ -1,5 +1,12 @@
 import { defineConfig } from 'vite'
+import { nodePolyfills } from 'vite-plugin-node-polyfills'
+
 export default defineConfig({
+  plugins: [
+    nodePolyfills({
+      include: ['buffer']
+    })
+  ],
   build: {
     assetsInlineLimit: 0,
     assetsDir: ''

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,7 +47,6 @@ interface IViyaTypesResponse {
   version: number
 }
 
-/* Item element within the Viya types response */
 interface IViyaTypesItem {
   description?: string
   extensions?: string[]
@@ -57,7 +56,7 @@ interface IViyaTypesItem {
   mappedTypes?: string[]
   mediaType?: string
   mediaTypes?: string[]
-  name?: string | undefined
+  name: string
   pluralLabel?: string
   properties?: IViyaTypesProperties
   resourceUri?: string
@@ -86,7 +85,7 @@ type IViyaTypesProperties = Record<string, string>
  * create and patch a new file.
  */
 interface IViyaTypesExtensionInfo {
-  typeDefName: string | undefined
+  typeDefName: string
   properties: IViyaTypesProperties | undefined
 }
 
@@ -115,9 +114,9 @@ export class SASViyaApiClient {
     this.requestClient
   )
   private folderMap = new Map<string, Job[]>()
+
   private fileExtensionMap = new Map<string, IViyaTypesExtensionInfo>()
-  private boolExtensionMap = false // required in case the map has zero entries
-  // after an attempt to populate it.
+  private boolExtensionMap = false // has the fileExtensionMap been populated yet?
 
   /**
    * A helper method used to call appendRequest method of RequestClient
@@ -482,20 +481,29 @@ 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 accepts this property during the file creation
+    // typeDefName - Viya should automatically determine this and additional
+    // properties at runtime if not provided in the file creation request.
     let typeDefName: string | undefined = undefined
-    // Additional properties are supplied by a patch.
+    // Viya update 2025.09 resulted in a change to this automatic behaviour.
+    // We patch the new file to replicate the behaviour.
     let filePatch:
       | {
           name: string
@@ -524,14 +532,8 @@ export class SASViyaApiClient {
           .forEach((e) => {
             e.extensions?.forEach((ext) => {
               this.fileExtensionMap.set(ext, {
-                // `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,
+                // "name:" is the typeDefName value required for file creation.
+                typeDefName: e.name,
                 properties: e.properties
               })
             })
@@ -540,18 +542,14 @@ 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'
@@ -562,13 +560,9 @@ export class SASViyaApiClient {
       headers
     )
 
-    // If a patch was created...
-    if (filePatch) {
-      try {
-        const patchHeaders = {
-          Accept: 'application/json',
-          'If-Match': '*'
-        }
+    try {
+      // If a patch was created...
+      if (filePatch) {
         // Get the URI of the newly created file
         const fileUri = createFileResponse.result.links.filter(
           (e) => e.method == 'PATCH' && e.rel == 'patch'
@@ -579,14 +573,15 @@ export class SASViyaApiClient {
             `${fileUri}`,
             filePatch,
             accessToken,
+            'application/json',
             patchHeaders
           )
         ).result
-      } catch (e: any) {
-        throw new Error(`Error patching file ${fileName}.\n${e.message}`)
       }
+      return createFileResponse.result
+    } catch (e: any) {
+      throw new Error(`Error patching file ${fileName}.\n${e.message}`)
     }
-    return createFileResponse.result
   }
 
   /**

src/request/RequestClient.ts

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