Skip to content

[ENHANCEMENT] set superactivity resource base to match s3 bundles location #285

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

Merged
andersweinstein merged 3 commits into from
Dec 10, 2025
Merged

[ENHANCEMENT] set superactivity resource base to match s3 bundles location #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0114300
ensure superactivity resourceBase is set correctly
Aug 18, 2025
55ff2de
cleanup
Aug 18, 2025
04c4598
remove special processing of ctat sequence files
Aug 26, 2025
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
22 changes: 19 additions & 3 deletions src/media.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,21 @@ export function transformToFlatDirectory(
['link', 'iframe', 'asset', 'interface', 'dataset'].includes(
$(e)[0].name
) ||
($(e)[0].name === 'source' && $(e).parent()[0].name === 'embed_activity');
($(e)[0].name === 'source' &&
($(e).parent()[0].name === 'embed_activity' ||
$(e).parent()[0].name === 'linked_activity'));

Object.keys(paths).forEach((assetReference: any) => {
const ref = { filePath, assetReference };

// Update the URL in the XML DOM
paths[assetReference].forEach((elem: cheerio.Element) => {
const isWebBundle =
mediaSummary.webContentBundle?.name && isWebBundleElement(elem);
const url =
// For link, iframe and superactivity source and webcontent assets, use a
// webBundle URL rather than a flattened media library URL when webBundle requested.
mediaSummary.webContentBundle?.name && isWebBundleElement(elem)
isWebBundle
? getWebBundleUrl(ref, projectDirectory, mediaSummary)
: flatten(ref, mediaSummary);

Expand All @@ -123,7 +127,15 @@ export function transformToFlatDirectory(
($(elem)[0].name === 'source' && $(elem).parent()[0].name !== 'video')
) {
// superactivity assets take paths relative to the media base url
const superMediaPath = url.slice(url.lastIndexOf('media/') + 6);
const superMediaPath = isWebBundle
? url.slice(
url.lastIndexOf(
`media/bundles/${mediaSummary.webContentBundle?.name}/`
) +
15 +
(mediaSummary.webContentBundle?.name?.length ?? 0)
)
: url.slice(url.lastIndexOf('media/') + 6);
const query = $(elem).text().split('?')[1];
$(elem).text(superMediaPath + (query ? `?${query}` : ''));
} else if ($(elem)[0].name === 'link') {
Expand Down Expand Up @@ -584,6 +596,10 @@ function findFromDOM(
paths[$(elem).text()] = [elem, ...$(paths[$(elem).text()])];
});

$('linked_activity source').each((i: any, elem: any) => {
paths[$(elem).text()] = [elem, ...$(paths[$(elem).text()])];
});

$('iframe').each((i: any, elem: any) => {
const src = $(elem).attr('src');
if (src !== undefined && isRelativeUrl(src)) {
Expand Down
114 changes: 17 additions & 97 deletions src/resources/superactivity.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ import { guid } from 'src/utils/common';
import * as XML from 'src/utils/xml';
import { Maybe } from 'tsmonad';
import { ProjectSummary } from 'src/project';
import { getWebBundleUrl } from 'src/media';
import * as DOM from 'src/utils/dom';
import * as fs from 'fs';

export class Superactivity extends Resource {
flagContentWarnigns(_$: any, _page: Page) {
Expand Down Expand Up @@ -50,10 +47,14 @@ export class Superactivity extends Resource {
file.includes('x-cmu-ctattutors') ||
navigable
) {
// x-cmu-ctattutors using sequence files need special processing
const modelXml = handleCtatSequenceFiles(xml, file, projectSummary);
const activity = toActivity(
toActivityModel(defaults.base, defaults.src, title, modelXml),
toActivityModel(
defaults.base,
defaults.src,
title,
xml,
projectSummary.mediaSummary.webContentBundle?.name
),
guid(),
defaults.subType,
title
Expand Down Expand Up @@ -84,7 +85,13 @@ export class Superactivity extends Resource {
} else {
resolve([
toActivity(
toActivityModel(defaults.base, defaults.src, title, xml),
toActivityModel(
defaults.base,
defaults.src,
title,
xml,
projectSummary.mediaSummary.webContentBundle?.name
),
legacyId,
defaults.subType,
title
Expand Down Expand Up @@ -224,11 +231,6 @@ function determineActivityDefaults(
base: 'embedded',
src: 'index.html',
};
// return {
// subType: 'oli_linked_activity',
// base: 'linked',
// src: 'linked.html',
// };
default:
return null;
}
Expand All @@ -238,13 +240,14 @@ function toActivityModel(
base: string,
src: string,
title: string,
modelXml: string
modelXml: string,
resourceBase?: string
) {
return {
base,
src,
modelXml,
resourceBase: guid(),
resourceBase: resourceBase ? 'bundles/' + resourceBase : guid(),
resourceURLs: [],
stem: {
id: guid(),
Expand Down Expand Up @@ -274,86 +277,3 @@ function toActivityModel(
},
};
}

// Some x-cmu-ctattutors have <interface> element referencing an xml "sequence"
// file defining a set of problems rather than an HTML file to be loaded. These
// sequence files contain relative URL references that must be translated, but
// are not resource files we would otherwise handle, rather just webcontent files.
// Here we construct torus variant sequence file with translated URLs and add it
// to the webcontent tree, adjusting the sequence file reference in the given
// modelXML to point to the torus variant. Because superactivity code detects
// by url ending in "/sequence.xml" we put it in /torus/ subdir of original file
// Returns: possibly modified modelXml
function handleCtatSequenceFiles(
modelXml: string,
filePath: string,
project: ProjectSummary
): string {
const interfaceRef = modelXml.substring(
modelXml.indexOf('<interface>') + '<interface>'.length,
modelXml.indexOf('</interface>')
);
if (interfaceRef.endsWith('sequence.xml')) {
if (!project.mediaSummary.webContentBundle?.name) {
console.log(
'CTAT w/sequence file requires webContentBundle option -- not handled'
);
return modelXml;
}

// ref was translated to web bundle URL. Get full path to file
const legacyRef = interfaceRef.substring(
interfaceRef.indexOf('/webcontent/')
);
const sequencePath = project.packageDirectory + '/content' + legacyRef;
console.log('Converting CTAT sequence file ' + sequencePath);

// translate asset refs in this file as we do for others.
const $ = DOM.read(sequencePath, {
xmlMode: true,
selfClosingTags: false,
});
fixSequenceFileRefs(sequencePath, $, project);

// to preserve /sequence.xml in path while leaving original file, we
// put transformed version into /torus/ subdirectory of original location
const newPath = sequencePath.replace('sequence.xml', 'torus/sequence.xml');
const dirPath = newPath.substring(0, newPath.lastIndexOf('/'));
if (!fs.existsSync(dirPath)) fs.mkdirSync(dirPath);
fs.writeFileSync(newPath, $.html());

// return modelXml adjusted to reference variant file
const newRef = interfaceRef.replace('sequence.xml', 'torus/sequence.xml');
return modelXml.replace(interfaceRef, newRef);
}

// else no sequence file, just return unchanged
return modelXml;
}

function fixSequenceFileRefs(
sequencePath: string,
$: cheerio.Root,
project: ProjectSummary
) {
const fixAttr = (item: cheerio.Element, attrName: string) => {
const value = $(item).attr(attrName);
if (value) {
const ref = { filePath: sequencePath, assetReference: value };
const url = getWebBundleUrl(
ref,
project.packageDirectory,
project.mediaSummary
);
if (url) {
const newRef = url.slice(url.lastIndexOf('media/') + 6);
$(item).attr(attrName, newRef);
}
}
};

$('Problems Problem').each((i: number, problem: any) => {
fixAttr(problem, 'problem_file');
fixAttr(problem, 'student_interface');
});
}
3 changes: 3 additions & 0 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
"alwaysStrict": true,
"outDir": "./dist",
"baseUrl": ".",
"paths": {
"src/*": ["src/*"]
},
"lib": ["es2015", "es2016", "es2017"],
},
"exclude": ["node_modules"]
Expand Down
Loading
Loading