Skip to content

Commit

Permalink
feat: add option to post VAST XML and replace creative URLs (#12)
Browse files Browse the repository at this point in the history 
* feat: add option to post VAST XML and replace creative URLs with master playlists

Signed-off-by: Fredrik Lundkvist <[email protected]>

* style: rename vastXml to vastXmlObj when dealing with parsed objects

Signed-off-by: Fredrik Lundkvist <[email protected]>

---------

Signed-off-by: Fredrik Lundkvist <[email protected]>
  • Loading branch information
@Lunkers
Lunkers authored Jan 24, 2025
1 parent 88dd1df commit 0aeab75
Showing 1 changed file with 78 additions and 22 deletions.
100 changes: 78 additions & 22 deletions src/vast/vastApi.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import { IN_PROGRESS } from '../redis/redisclient';
export const ManifestAsset = Type.Object({
creativeId: Type.String(),
masterPlaylistUrl: Type.String()
// TODO: Figure out how to handle durations
});

export const ManifestResponse = Type.Object({
Expand Down Expand Up @@ -50,7 +49,19 @@ export const vastApi: FastifyPluginCallback<AdApiOptions> = (
next
) => {
fastify.register(fastifyAcceptsSerializer);

fastify.addContentTypeParser(
['text/xml', 'application/xml'],
{ parseAs: 'string' },
(req, body, done) => {
try {
const parsed = parseVast(body.toString());
done(null, parsed);
} catch (error) {
logger.error('Failed to parse VAST XML', error);
done(new Error('Failed to parse VAST XML'), undefined);
}
}
);
fastify.get<{ Reply: Static<typeof ManifestResponse> }>(
'/api/v1/vast',
{
Expand Down Expand Up @@ -80,7 +91,44 @@ export const vastApi: FastifyPluginCallback<AdApiOptions> = (
},
async (req, reply) => {
const path = req.url;
const response = await fetchVastAndDispatchJobs(path, opts);
const vastStr = await getVastXml(opts.adServerUrl, path);
const vastXml = parseVast(vastStr);
const response = await findMissingAndDispatchJobs(vastXml, opts);
reply.send(response);
}
);

fastify.post<{ Body: XMLDocument }>(
'/api/v1/vast',
{
config: {
serializers: [
{
regex: /^application\/xml/,
serializer: (data: ManifestResponse) => {
return replaceMediaFiles(data.vastXml, data.assets);
}
},
{
regex: /^application\/json/,
serializer: (data: ManifestResponse) => {
return createAssetList(data.vastXml, data.assets);
}
}
]
},
schema: {
description:
'Accepts VAST XML and returns data containing manifest URLs for creatives with transcoded assets.',

response: {
200: ManifestResponse
}
}
},
async (req, reply) => {
const vastXml = req.body;
const response = await findMissingAndDispatchJobs(vastXml, opts);
reply.send(response);
}
);
Expand Down Expand Up @@ -112,12 +160,11 @@ const partitionCreatives = async (
return [found, missing];
};

const fetchVastAndDispatchJobs = async (
path: string,
const findMissingAndDispatchJobs = async (
vastXmlObj: any,
opts: AdApiOptions
): Promise<ManifestResponse> => {
const vastXml = await getVastXml(opts.adServerUrl, path);
const creatives = await getCreatives(vastXml);
const creatives = await getCreatives(vastXmlObj);
const [found, missing] = await partitionCreatives(
creatives,
opts.lookUpAsset
Expand Down Expand Up @@ -172,7 +219,9 @@ const fetchVastAndDispatchJobs = async (
)
};
});
return { assets: withBaseUrl, vastXml };
const builder = new XMLBuilder({ format: true, ignoreAttributes: false });
const vastXml = builder.build(vastXmlObj);
return { assets: withBaseUrl, vastXml: vastXml };
};

const getVastXml = async (
Expand Down Expand Up @@ -202,19 +251,16 @@ const getVastXml = async (
}
};

const getCreatives = async (vastXml: string): Promise<ManifestAsset[]> => {
const getCreatives = async (vastXml: any): Promise<ManifestAsset[]> => {
try {
const parser = new XMLParser();
const parsedVAST = parser.parse(vastXml);
if (parsedVAST.VAST.Ad) {
const creatives = parsedVAST.VAST.Ad.reduce(
if (vastXml.VAST.Ad) {
const creatives = vastXml.VAST.Ad.reduce(
(acc: ManifestAsset[], ad: any) => {
const adId = ad.InLine.Creatives.Creative.UniversalAdId.replace(
/[^a-zA-Z0-9]/g,
''
);
const adId = ad.InLine.Creatives.Creative.UniversalAdId[
'#text'
].replace(/[^a-zA-Z0-9]/g, '');
const mediaFile =
ad.InLine.Creatives.Creative.Linear.MediaFiles.MediaFile;
ad.InLine.Creatives.Creative.Linear.MediaFiles.MediaFile['#text'];
return [...acc, { creativeId: adId, masterPlaylistUrl: mediaFile }];
},
[]
Expand All @@ -223,7 +269,7 @@ const getCreatives = async (vastXml: string): Promise<ManifestAsset[]> => {
}
return [];
} catch (error) {
logger.error('Failed to parse VAST XML', { error });
logger.error('Failed to parse VAST XML', error);
return [];
}
};
Expand All @@ -250,17 +296,27 @@ const replaceMediaFiles = (vastXml: string, assets: ManifestAsset[]) => {
const modifiedVastXml = builder.build(parsedVAST);
return modifiedVastXml;
} catch (error) {
logger.error('Failed to replace media files', { error });
logger.error('Failed to replace media files', error);
return vastXml;
}
};

const parseVast = (vastXml: string) => {
try {
const parser = new XMLParser({ ignoreAttributes: false });
const parsedVAST = parser.parse(vastXml);
return parsedVAST;
} catch (error) {
logger.error('Failed to parse VAST XML', { error });
return {};
}
};

const createAssetList = (vastXml: string, assets: ManifestAsset[]) => {
let assetDescriptions = [];
try {
const parser = new XMLParser({ ignoreAttributes: false });
const parsedVAST = parser.parse(vastXml);

if (parsedVAST.VAST.Ad) {
assetDescriptions = parsedVAST.VAST.Ad.map((ad: any) => {
const adId = ad.InLine.Creatives.Creative.UniversalAdId[
Expand All @@ -280,7 +336,7 @@ const createAssetList = (vastXml: string, assets: ManifestAsset[]) => {
}
} catch (error) {
const fallbackDuration = 10;
logger.error('Failed to create asset list', { error });
logger.error('Failed to create asset list', error);
assetDescriptions = assets.map((asset) => {
return {
URI: asset.masterPlaylistUrl,
Expand Down

0 comments on commit 0aeab75

Please sign in to comment.