CodeMirror/budibase
1
0
Fork 0
mirror of synced 2024-09-12 23:43:09 +12:00
Code Issues Projects Releases Wiki Activity

Typing improvements around the REST integration to make sure when no response is returned it doesn't break anything.

Browse source
This commit is contained in:
mike12345567 2024-05-08 16:08:29 +01:00
parent 1d300c2577
commit fd94e3aea9
1 changed files with 25 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
packages/server/src/integrations/rest.ts
View file

@ -26,13 +26,13 @@ import { parse } from "content-disposition"
import path from "path" import path from "path"
import { Builder as XmlBuilder } from "xml2js" import { Builder as XmlBuilder } from "xml2js"
const BodyTypes = { enum BodyType {
NONE: "none", NONE = "none",
FORM_DATA: "form", FORM_DATA = "form",
XML: "xml", XML = "xml",
ENCODED: "encoded", ENCODED = "encoded",
JSON: "json", JSON = "json",
TEXT: "text", TEXT = "text",
} }
const coreFields = { const coreFields = {
@ -54,7 +54,7 @@ const coreFields = {
}, },
bodyType: { bodyType: {
type: DatasourceFieldType.STRING, type: DatasourceFieldType.STRING,
enum: Object.values(BodyTypes), enum: Object.values(BodyType),
}, },
pagination: { pagination: {
type: DatasourceFieldType.OBJECT, type: DatasourceFieldType.OBJECT,
@ -131,7 +131,10 @@ class RestIntegration implements IntegrationBase {
} }
async parseResponse(response: any, pagination: PaginationConfig | null) { async parseResponse(response: any, pagination: PaginationConfig | null) {
let data, raw, headers, filename let data: any[] | string | undefined,
raw: string | undefined,
headers: Record<string, string> = {},
filename: string | undefined
const contentType = response.headers.get("content-type") || "" const contentType = response.headers.get("content-type") || ""
const contentDisposition = response.headers.get("content-disposition") || "" const contentDisposition = response.headers.get("content-disposition") || ""
@ -149,7 +152,7 @@ class RestIntegration implements IntegrationBase {
} else { } else {
if (response.status === 204) { if (response.status === 204) {
data = [] data = []
raw = [] raw = ""
} else if (contentType.includes("application/json")) { } else if (contentType.includes("application/json")) {
data = await response.json() data = await response.json()
raw = JSON.stringify(data) raw = JSON.stringify(data)
@ -162,16 +165,18 @@ class RestIntegration implements IntegrationBase {
raw = xmlResponse.rawXml raw = xmlResponse.rawXml
} else { } else {
data = await response.text() data = await response.text()
raw = data raw = data as string
} }
} }
} catch (err) { } catch (err) {
throw `Failed to parse response body: ${err}` throw `Failed to parse response body: ${err}`
} }
const size = formatBytes( let contentLength: string = response.headers.get("content-length")
response.headers.get("content-length") || Buffer.byteLength(raw, "utf8") if (!contentLength && raw) {
) contentLength = Buffer.byteLength(raw, "utf8").toString()
}
const size = formatBytes(contentLength || "0")
const time = `${Math.round(performance.now() - this.startTimeMs)}ms` const time = `${Math.round(performance.now() - this.startTimeMs)}ms`
headers = response.headers.raw() headers = response.headers.raw()
for (let [key, value] of Object.entries(headers)) { for (let [key, value] of Object.entries(headers)) {
@ -255,7 +260,7 @@ class RestIntegration implements IntegrationBase {
if (!input.headers) { if (!input.headers) {
input.headers = {} input.headers = {}
} }
if (bodyType === BodyTypes.NONE) { if (bodyType === BodyType.NONE) {
return input return input
} }
let error, let error,
@ -283,11 +288,11 @@ class RestIntegration implements IntegrationBase {
} }
switch (bodyType) { switch (bodyType) {
case BodyTypes.TEXT: case BodyType.TEXT:
// content type defaults to plaintext // content type defaults to plaintext
input.body = string input.body = string
break break
case BodyTypes.ENCODED: { case BodyType.ENCODED: {
const params = new URLSearchParams() const params = new URLSearchParams()
for (let [key, value] of Object.entries(object)) { for (let [key, value] of Object.entries(object)) {
params.append(key, value as string) params.append(key, value as string)
@ -298,7 +303,7 @@ class RestIntegration implements IntegrationBase {
input.body = params input.body = params
break break
} }
case BodyTypes.FORM_DATA: { case BodyType.FORM_DATA: {
const form = new FormData() const form = new FormData()
for (let [key, value] of Object.entries(object)) { for (let [key, value] of Object.entries(object)) {
form.append(key, value) form.append(key, value)
@ -309,14 +314,14 @@ class RestIntegration implements IntegrationBase {
input.body = form input.body = form
break break
} }
case BodyTypes.XML: case BodyType.XML:
if (object != null && Object.keys(object).length) { if (object != null && Object.keys(object).length) {
string = new XmlBuilder().buildObject(object) string = new XmlBuilder().buildObject(object)
} }
input.body = string input.body = string
input.headers["Content-Type"] = "application/xml" input.headers["Content-Type"] = "application/xml"
break break
case BodyTypes.JSON: case BodyType.JSON:
// if JSON error, throw it // if JSON error, throw it
if (error) { if (error) {
throw "Invalid JSON for request body" throw "Invalid JSON for request body"