-
Notifications
You must be signed in to change notification settings - Fork 3.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add XML to JSON operation #1631
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -66,6 +66,7 @@ | |
"CSV to JSON", | ||
"JSON to CSV", | ||
"Avro to JSON", | ||
"XML to JSON", | ||
"CBOR Encode", | ||
"CBOR Decode" | ||
] | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
/** | ||
* @author jpledref [[email protected]] | ||
* @copyright Crown Copyright 2023 | ||
* @license Apache-2.0 | ||
*/ | ||
|
||
import xml2js from "xml2js"; | ||
import Operation from "../Operation.mjs"; | ||
import OperationError from "../errors/OperationError.mjs"; | ||
|
||
/** | ||
* XML to JSON operation | ||
*/ | ||
class XMLToJSON extends Operation { | ||
|
||
/** | ||
* XMLToJSON constructor | ||
*/ | ||
constructor() { | ||
super(); | ||
|
||
this.name = "XML to JSON"; | ||
this.module = "Default"; | ||
this.description = "Converts XML data to JSON format."; | ||
this.infoURL = "https://wikipedia.org/wiki/XML"; | ||
this.inputType = "string"; | ||
this.outputType = "JSON"; | ||
this.args = [ | ||
]; | ||
} | ||
|
||
/** | ||
* @param {string} input | ||
* @param {Object[]} args | ||
* @returns {JSON} | ||
*/ | ||
run(input, args) { | ||
let result; | ||
try { | ||
xml2js.parseString(input, {}, (e, r) => result = JSON.stringify(r)); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're not using the error result in the callback. I assume xml2js uses that rather than throwing an error, and it's going to include useful parser errors. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're taking the return value, encoding it into JSON and then parsing it back again. That seems unnecessary, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's a callback here: is xml2js synchronous or asynchronous? It might be safer to return a Promise that handles the callback result. |
||
return JSON.parse(result); | ||
} catch (err) { | ||
throw new OperationError("Unable to parse XML to JSON: " + err.toString()); | ||
} | ||
} | ||
|
||
} | ||
|
||
export default XMLToJSON; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
/** | ||
* XML to JSON tests. | ||
* | ||
* @author jpledref [[email protected]] | ||
* @copyright Crown Copyright 2023 | ||
* @license Apache-2.0 | ||
*/ | ||
import TestRegister from "../../lib/TestRegister.mjs"; | ||
|
||
const EXPECTED_JSON = { "root": {"shelf": ["over"], "wood": ["do"], "natural": ["sale"]}}; | ||
|
||
TestRegister.addTests([ | ||
{ | ||
name: "XML to JSON", | ||
input: "<root>\n<shelf>over</shelf>\n<wood>do</wood>\n<natural>sale</natural>\n</root>", | ||
expectedOutput: EXPECTED_JSON, | ||
recipeConfig: [ | ||
{ | ||
op: "XML to JSON", | ||
args: [] | ||
}, | ||
], | ||
} | ||
]); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this used?