1
0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-16 16:40:06 +00:00

Compare commits

..

1 Commits

Author SHA1 Message Date
Trevor Moody
d0aaad024b fix: improved Viya createFile to apply related properties 2025-11-20 13:00:34 +00:00
4 changed files with 163 additions and 173 deletions

View File

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

View File

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

View File

@@ -35,7 +35,7 @@ interface JobExecutionResult {
log?: string log?: string
error?: object error?: object
} }
/* Viya /types/types?limit=999999 response structure */
interface IViyaTypesResponse { interface IViyaTypesResponse {
accept: string accept: string
count: number count: number
@@ -47,7 +47,6 @@ interface IViyaTypesResponse {
version: number version: number
} }
/* Item element within the Viya types response */
interface IViyaTypesItem { interface IViyaTypesItem {
description?: string description?: string
extensions?: string[] extensions?: string[]
@@ -57,7 +56,7 @@ interface IViyaTypesItem {
mappedTypes?: string[] mappedTypes?: string[]
mediaType?: string mediaType?: string
mediaTypes?: string[] mediaTypes?: string[]
name?: string | undefined name: string
pluralLabel?: string pluralLabel?: string
properties?: IViyaTypesProperties properties?: IViyaTypesProperties
resourceUri?: string resourceUri?: string
@@ -71,14 +70,18 @@ interface IViyaTypesItem {
* in the links array of a Viya * in the links array of a Viya
* types/types api response * types/types api response
*/ */
type IViyaTypesLink = Record<string, string> interface IViyaTypesLink {
[key: string]: string
}
/** /**
* Generic structure for a type's * Generic structure for a type's
* 'properties' object from the Viya * 'properties' object from the Viya
* types/types api response * types/types api response
*/ */
type IViyaTypesProperties = Record<string, string> interface IViyaTypesProperties {
[key: string]: string
}
/** /**
* Arbitrary interface for storing * Arbitrary interface for storing
@@ -86,7 +89,7 @@ type IViyaTypesProperties = Record<string, string>
* create and patch a new file. * create and patch a new file.
*/ */
interface IViyaTypesExtensionInfo { interface IViyaTypesExtensionInfo {
typeDefName: string | undefined typeDefName: string
properties: IViyaTypesProperties | undefined properties: IViyaTypesProperties | undefined
} }
@@ -115,9 +118,9 @@ export class SASViyaApiClient {
this.requestClient this.requestClient
) )
private folderMap = new Map<string, Job[]>() private folderMap = new Map<string, Job[]>()
private fileExtensionMap = new Map<string, IViyaTypesExtensionInfo>() private fileExtensionMap = new Map<string, IViyaTypesExtensionInfo>()
private boolExtensionMap = false // required in case the map has zero entries private boolExtensionMap = false // has the fileExtensionMap been populated yet?
// after an attempt to populate it.
/** /**
* A helper method used to call appendRequest method of RequestClient * A helper method used to call appendRequest method of RequestClient
@@ -491,11 +494,17 @@ export class SASViyaApiClient {
const formData = new NodeFormData() const formData = new NodeFormData()
formData.append('file', contentBuffer, fileName) 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 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: let filePatch:
| { | {
name: string name: string
@@ -524,14 +533,7 @@ export class SASViyaApiClient {
.forEach((e) => { .forEach((e) => {
e.extensions?.forEach((ext) => { e.extensions?.forEach((ext) => {
this.fileExtensionMap.set(ext, { this.fileExtensionMap.set(ext, {
// `name` becomes the typeDefName value at file creation time. typeDefName: e.name, // "name:" is the typeDefName value required for file creation.
// `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 properties: e.properties
}) })
}) })
@@ -540,53 +542,42 @@ export class SASViyaApiClient {
this.boolExtensionMap = true this.boolExtensionMap = true
} }
// Query the map for the current file extension
const fileExtInfo = this.fileExtensionMap.get(fileExtension) const fileExtInfo = this.fileExtensionMap.get(fileExtension)
if (fileExtInfo) { 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 typeDefName = fileExtInfo.typeDefName
if (fileExtInfo.properties) if (fileExtInfo.properties)
filePatch = { name: fileName, properties: fileExtInfo.properties } filePatch = { name: fileName, properties: fileExtInfo.properties }
} }
} }
// Create the file return (
const createFileResponse = await this.requestClient.post<File>( await this.requestClient
`/files/files?parentFolderUri=${parentFolderUri}&typeDefName=${ .post<File>(
typeDefName ?? 'file' `/files/files?parentFolderUri=${parentFolderUri}&typeDefName=${
}#rawUpload`, typeDefName ?? 'file'
formData, }#rawUpload`,
accessToken, formData,
'multipart/form-data; boundary=' + (formData as any)._boundary, accessToken,
headers 'multipart/form-data; boundary=' + (formData as any)._boundary,
) headers
)
// If a patch was created... .then(async (res) => {
if (filePatch) { // If a patch was created...
try { if (filePatch) {
const patchHeaders = { // Get the URI of the newly created file
Accept: 'application/json', const fileUri = res.result.links.filter(
'If-Match': '*' (e) => e.method == 'PATCH' && e.rel == 'patch'
} )[0].uri
// Get the URI of the newly created file // and apply the patch
const fileUri = createFileResponse.result.links.filter( return await this.requestClient.patch<File>(
(e) => e.method == 'PATCH' && e.rel == 'patch' `${fileUri}`,
)[0].uri filePatch,
// and apply the patch accessToken
return ( )
await this.requestClient.patch<File>( }
`${fileUri}`, return res
filePatch, })
accessToken, ).result
patchHeaders
)
).result
} catch (e: any) {
throw new Error(`Error patching file ${fileName}.\n${e.message}`)
}
}
return createFileResponse.result
} }
/** /**

View File

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