mirror of
https://github.com/sasjs/adapter.git
synced 2025-12-11 01:14:36 +00:00
Compare commits
3 Commits
master
...
a3c5e985f7
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a3c5e985f7 | ||
|
|
68e0da8a91 | ||
|
|
d0aaad024b |
@@ -1,43 +1,39 @@
|
|||||||
* {
|
* {
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
padding: 0;
|
padding: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
|
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
|
||||||
Ubuntu, Cantarell, sans-serif;
|
Ubuntu, Cantarell, sans-serif;
|
||||||
line-height: 1.6;
|
line-height: 1.6;
|
||||||
color: #333;
|
color: #333;
|
||||||
background: #f5f5f5;
|
background: #f5f5f5;
|
||||||
}
|
}
|
||||||
|
|
||||||
#app {
|
.app__error {
|
||||||
min-height: 100vh;
|
max-width: 800px;
|
||||||
}
|
margin: 50px auto;
|
||||||
|
padding: 30px;
|
||||||
.app__error {
|
background: white;
|
||||||
max-width: 800px;
|
border-radius: 8px;
|
||||||
margin: 50px auto;
|
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
|
||||||
padding: 30px;
|
|
||||||
background: white;
|
h1 {
|
||||||
border-radius: 8px;
|
color: #e74c3c;
|
||||||
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
|
margin-bottom: 15px;
|
||||||
|
}
|
||||||
h1 {
|
|
||||||
color: #e74c3c;
|
p {
|
||||||
margin-bottom: 15px;
|
margin-bottom: 15px;
|
||||||
}
|
}
|
||||||
|
|
||||||
p {
|
pre {
|
||||||
margin-bottom: 15px;
|
background: #2c3e50;
|
||||||
}
|
color: #ecf0f1;
|
||||||
|
padding: 15px;
|
||||||
pre {
|
border-radius: 4px;
|
||||||
background: #2c3e50;
|
overflow-x: auto;
|
||||||
color: #ecf0f1;
|
}
|
||||||
padding: 15px;
|
|
||||||
border-radius: 4px;
|
|
||||||
overflow-x: auto;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -22,6 +22,7 @@ import { sendArrTests, sendObjTests } from './testSuites/RequestData'
|
|||||||
import { fileUploadTests } from './testSuites/FileUpload'
|
import { fileUploadTests } from './testSuites/FileUpload'
|
||||||
import { computeTests } from './testSuites/Compute'
|
import { computeTests } from './testSuites/Compute'
|
||||||
import { sasjsRequestTests } from './testSuites/SasjsRequests'
|
import { sasjsRequestTests } from './testSuites/SasjsRequests'
|
||||||
|
import { viyaFileTests } from './testSuites/ViyaFile'
|
||||||
|
|
||||||
async function init() {
|
async function init() {
|
||||||
const appContainer = document.getElementById('app')
|
const appContainer = document.getElementById('app')
|
||||||
@@ -103,9 +104,10 @@ function showTests(
|
|||||||
fileUploadTests(adapter)
|
fileUploadTests(adapter)
|
||||||
]
|
]
|
||||||
|
|
||||||
// Add compute tests for SASVIYA only
|
// Add certain tests for SASVIYA only
|
||||||
if (adapter.getSasjsConfig().serverType === 'SASVIYA') {
|
if (adapter.getSasjsConfig().serverType === 'SASVIYA') {
|
||||||
testSuites.push(computeTests(adapter, appLoc))
|
testSuites.push(computeTests(adapter, appLoc))
|
||||||
|
testSuites.push(viyaFileTests(adapter, appLoc))
|
||||||
}
|
}
|
||||||
|
|
||||||
container.innerHTML = ''
|
container.innerHTML = ''
|
||||||
|
|||||||
31
sasjs-tests/src/testSuites/ViyaFile.ts
Normal file
31
sasjs-tests/src/testSuites/ViyaFile.ts
Normal file
@@ -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
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
@@ -36,6 +36,59 @@ interface JobExecutionResult {
|
|||||||
error?: object
|
error?: object
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface IViyaTypesResponse {
|
||||||
|
accept: string
|
||||||
|
count: number
|
||||||
|
items: IViyaTypesItem[]
|
||||||
|
limit: number
|
||||||
|
links: IViyaTypesLink[]
|
||||||
|
name: string
|
||||||
|
start: number
|
||||||
|
version: number
|
||||||
|
}
|
||||||
|
|
||||||
|
interface IViyaTypesItem {
|
||||||
|
description?: string
|
||||||
|
extensions?: string[]
|
||||||
|
iconUri?: string
|
||||||
|
label: string
|
||||||
|
links: IViyaTypesLink[]
|
||||||
|
mappedTypes?: string[]
|
||||||
|
mediaType?: string
|
||||||
|
mediaTypes?: string[]
|
||||||
|
name: string
|
||||||
|
pluralLabel?: string
|
||||||
|
properties?: IViyaTypesProperties
|
||||||
|
resourceUri?: string
|
||||||
|
serviceRootUri?: string
|
||||||
|
tags?: string[]
|
||||||
|
version: number
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generic structure for a link
|
||||||
|
* in the links array of a Viya
|
||||||
|
* types/types api response
|
||||||
|
*/
|
||||||
|
type IViyaTypesLink = Record<string, string>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generic structure for a type's
|
||||||
|
* 'properties' object from the Viya
|
||||||
|
* types/types api response
|
||||||
|
*/
|
||||||
|
type IViyaTypesProperties = Record<string, string>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Arbitrary interface for storing
|
||||||
|
* sufficient additional detail to
|
||||||
|
* create and patch a new file.
|
||||||
|
*/
|
||||||
|
interface IViyaTypesExtensionInfo {
|
||||||
|
typeDefName: string
|
||||||
|
properties: IViyaTypesProperties | undefined
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A client for interfacing with the SAS Viya REST API.
|
* A client for interfacing with the SAS Viya REST API.
|
||||||
*
|
*
|
||||||
@@ -62,6 +115,9 @@ export class SASViyaApiClient {
|
|||||||
)
|
)
|
||||||
private folderMap = new Map<string, Job[]>()
|
private folderMap = new Map<string, Job[]>()
|
||||||
|
|
||||||
|
private fileExtensionMap = new Map<string, IViyaTypesExtensionInfo>()
|
||||||
|
private boolExtensionMap = false // has the fileExtensionMap been populated yet?
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A helper method used to call appendRequest method of RequestClient
|
* A helper method used to call appendRequest method of RequestClient
|
||||||
* @param response - response from sasjs request
|
* @param response - response from sasjs request
|
||||||
@@ -434,14 +490,89 @@ 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.
|
||||||
|
* 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
|
||||||
|
// 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.
|
||||||
|
// We patch the new file to replicate the behaviour.
|
||||||
|
let filePatch:
|
||||||
|
| {
|
||||||
|
name: string
|
||||||
|
properties: IViyaTypesProperties | undefined
|
||||||
|
}
|
||||||
|
| undefined = undefined
|
||||||
|
|
||||||
|
// The patching process requires properties related to the file-extension
|
||||||
|
const fileExtension: string | undefined = fileName
|
||||||
|
.split('.')
|
||||||
|
.pop()
|
||||||
|
?.toLowerCase()
|
||||||
|
|
||||||
|
if (fileExtension) {
|
||||||
|
if (!this.boolExtensionMap) {
|
||||||
|
// Populate the file extension map
|
||||||
|
// 1. Get Viya's response to this api call
|
||||||
|
const typesQueryUrl = `/types/types?limit=999999`
|
||||||
|
const response = (
|
||||||
|
await this.requestClient.get(typesQueryUrl, accessToken)
|
||||||
|
).result as IViyaTypesResponse
|
||||||
|
// 2. Filter the returned items that have file extensions into a map
|
||||||
|
// using forEach as an item may relate to multiple file extensions.
|
||||||
|
response.items
|
||||||
|
.filter((e) => e.extensions)
|
||||||
|
.forEach((e) => {
|
||||||
|
e.extensions?.forEach((ext) => {
|
||||||
|
this.fileExtensionMap.set(ext, {
|
||||||
|
typeDefName: e.name, // "name:" is the typeDefName value required for file creation.
|
||||||
|
properties: e.properties
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
// 3. Toggle the flag to avoid repeating this step
|
||||||
|
this.boolExtensionMap = true
|
||||||
|
}
|
||||||
|
|
||||||
|
const fileExtInfo = this.fileExtensionMap.get(fileExtension)
|
||||||
|
if (fileExtInfo) {
|
||||||
|
typeDefName = fileExtInfo.typeDefName
|
||||||
|
if (fileExtInfo.properties)
|
||||||
|
filePatch = { name: fileName, properties: fileExtInfo.properties }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return (
|
return (
|
||||||
await this.requestClient.post<File>(
|
await this.requestClient
|
||||||
`/files/files?parentFolderUri=${parentFolderUri}&typeDefName=file#rawUpload`,
|
.post<File>(
|
||||||
formData,
|
`/files/files?parentFolderUri=${parentFolderUri}&typeDefName=${
|
||||||
accessToken,
|
typeDefName ?? 'file'
|
||||||
'multipart/form-data; boundary=' + (formData as any)._boundary,
|
}#rawUpload`,
|
||||||
headers
|
formData,
|
||||||
)
|
accessToken,
|
||||||
|
'multipart/form-data; boundary=' + (formData as any)._boundary,
|
||||||
|
headers
|
||||||
|
)
|
||||||
|
.then(async (res) => {
|
||||||
|
// If a patch was created...
|
||||||
|
if (filePatch) {
|
||||||
|
// Get the URI of the newly created file
|
||||||
|
const fileUri = res.result.links.filter(
|
||||||
|
(e) => e.method == 'PATCH' && e.rel == 'patch'
|
||||||
|
)[0].uri
|
||||||
|
// and apply the patch
|
||||||
|
return await this.requestClient.patch<File>(
|
||||||
|
`${fileUri}`,
|
||||||
|
filePatch,
|
||||||
|
accessToken
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return res
|
||||||
|
})
|
||||||
).result
|
).result
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user