Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Replace xml-js with fast-xml-parser #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Replace xml-js with fast-xml-parser #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 30 additions & 16 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/vast-parser/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"test": "uvu -r ts-node/register tests"
},
"dependencies": {
"xml-js": "^1.6.11"
"fast-xml-parser": "^4.5.0"
},
"devDependencies": {
"buffer": "^6.0.3",
Expand Down
44 changes: 30 additions & 14 deletions packages/vast-parser/src/VASTParser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import convert from 'xml-js';
import { XMLParser, XMLBuilder } from 'fast-xml-parser';
import { mapArrayOrElem } from '../../utils/src';
import type { XmlVASTRoot } from "./XmlVAST";
import Creative from "./Creative";
Expand Down Expand Up @@ -27,6 +27,20 @@ export default class VASTParser {
*/
constructor(vast: string) {
this._originalVAST = vast;
this._parser = new XMLParser({
ignoreAttributes: false,
attributeNamePrefix: '',
attributesGroupName: '_attributes',
cdataPropName: '_cdata',
alwaysCreateTextNode: true,
textNodeName: '_text',
});
this._builder = new XMLBuilder({
attributeNamePrefix: '',
attributesGroupName: '_attributes',
cdataPropName: '_cdata',
textNodeName: '_text',
});
}

/**
Expand All @@ -38,33 +52,35 @@ export default class VASTParser {
}

private _originalVAST: string;
private _parser: XMLParser;
private _builder: XMLBuilder;

private _parseVAST(vast: string): VAST | null {
const vastRoot: XmlVASTRoot = convert.xml2js(vast, { compact: true }) as XmlVASTRoot;
const vastRoot: XmlVASTRoot = this._parser.parse(vast) as XmlVASTRoot;
const vastObj = vastRoot.VAST;
const ads = mapArrayOrElem(vastObj.Ad, ad => {
if (!ad) return null;
const inLineNode = ad.InLine;
if (!inLineNode) return null;

const errorNode = inLineNode.Error;
let errors: string[] = [];
if (errorNode) {
errors = mapArrayOrElem(errorNode, error => {
if (!error._cdata) return null;
return error._cdata;
if (!error._cdata || !error._cdata._text) return null;
return error._cdata._text;
});
}

const extensionsNode = inLineNode.Extensions;
let extensions: Extension[] = [];
if (extensionsNode && extensionsNode.Extension) {
extensions = mapArrayOrElem(extensionsNode.Extension, extension => {
const customXML = convert.js2xml(extension as convert.ElementCompact, { compact: true });
const customXML = this._builder.build(extension);
return new Extension(customXML, extension._attributes?.type);
});
}

const creativeNode = inLineNode.Creatives?.Creative;
if (!creativeNode) return null;
const creatives = mapArrayOrElem(creativeNode, creative => {
Expand All @@ -86,7 +102,7 @@ export default class VASTParser {
const mediaFileNode = linearNode?.MediaFiles?.MediaFile;
if (!mediaFileNode) return null;
const mediaFiles = mapArrayOrElem(mediaFileNode, mediaFile => {
const url = mediaFile._cdata;
const url = mediaFile._cdata._text;
const delivery = mediaFile._attributes.delivery;
const type = mediaFile._attributes.type;
const width = parseInt(mediaFile._attributes.width);
Expand All @@ -110,35 +126,35 @@ export default class VASTParser {
);
return newMediaFile;
});

const trackingNode = linearNode?.TrackingEvents?.Tracking;
if (trackingNode) {
trackingEvents = mapArrayOrElem(trackingNode, tracking => {
const event = tracking._attributes.event;
const url = tracking._cdata;
const url = tracking._cdata._text;
return new Tracking(url, event);
});
}

const adParameters = linearNode?.AdParameters?._cdata;
const adParameters = linearNode?.AdParameters?._cdata._text;

const creativeExtensionsNode = creative.CreativeExtensions;
let creativeExtensions: CreativeExtension[] = [];
if (creativeExtensionsNode) {
creativeExtensions = mapArrayOrElem(creativeExtensionsNode.CreativeExtension, creativeExtension => {
const customXML = convert.js2xml(creativeExtension, { compact: true });
const customXML = this._builder.build(creativeExtension);
return new CreativeExtension(customXML, creativeExtension._attributes?.type);
});
}

const linear = new Linear(duration, mediaFiles, trackingEvents, adParameters, skipoffset);

return new Creative(creative._attributes.id, parseInt(creative._attributes.sequence), linear);
});

const impressions = mapArrayOrElem(inLineNode.Impression, impression => {
if (!impression._cdata) return null;
return new Impression(impression._cdata);
return new Impression(impression._cdata._text);
});
const inLine = new InLine('', '', impressions, creatives, void 0, void 0, void 0, void 0, void 0, errors, extensions);
const newAd = new Ad(ad._attributes?.id, ad._attributes?.sequence ? parseInt(ad._attributes.sequence) : void 0, inLine);
Expand Down
Loading