Skip to content

test: cover editor controller orchestration #123

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
erseco merged 7 commits into from
Sep 22, 2026
Merged

test: cover editor controller orchestration #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8e2e153
refactor: extract editor HTML preparation service
erseco Sep 22, 2026
233668a
refactor: delegate editor HTML preparation
erseco Sep 22, 2026
e779c0f
test: extend request stub for editor controller
erseco Sep 22, 2026
12cb764
test: cover editor HTML preparation
erseco Sep 22, 2026
11aae69
test: cover editor controller orchestration
erseco Sep 22, 2026
c4402ee
test: include editor controller in PHP coverage
erseco Sep 22, 2026
957d17e
test: isolate editor controller scenarios
erseco Sep 22, 2026
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
187 changes: 3 additions & 184 deletions lib/Controller/EditorController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace OCA\ExeLearning\Controller;

use OCA\ExeLearning\AppInfo\Application;
use OCA\ExeLearning\Service\EditorHtmlService;
use OCA\ExeLearning\Service\ElpxPackageService;
use OCA\ExeLearning\Service\LegacyFileMigrationService;
use OCP\AppFramework\Controller;
Expand Down Expand Up @@ -39,6 +40,7 @@ public function __construct(
private readonly IUserSession $userSession,
private readonly ElpxPackageService $packageService,
private readonly LegacyFileMigrationService $legacyFileMigration,
private readonly EditorHtmlService $editorHtml,
private readonly IInitialState $initialState,
private readonly IURLGenerator $urlGenerator,
) {
Expand Down Expand Up @@ -198,35 +200,7 @@ public function iframe(): DataDisplayResponse|DataResponse {
// save. Deriving from `document.baseURI` (which equals the scoped
// `<base href>` at runtime) keeps it correct in both a normal install and
// under a scoped path.
$staticConfig = json_encode([
'hideUI' => (object)[
'fileMenu' => true,
'saveButton' => true,
'shareButton' => false,
'userMenu' => true,
'downloadButton' => false,
'helpMenu' => false,
],
], JSON_UNESCAPED_SLASHES);

$configScript = '<script>(function(){'
. 'var base=new URL(".",document.baseURI).href.replace(/\\/+$/,"");'
. 'var origin=window.location.origin;'
. 'window.__EXE_EMBEDDING_CONFIG__=Object.assign(' . $staticConfig . ','
. '{basePath:base,parentOrigin:origin,trustedOrigins:[origin]});'
. '})();</script>';

// The resilience shim must be installed before any editor script
// runs (it wraps fetch / jQuery.ajax / serviceWorker.register), so it
// goes right after <base> and before the embedding config.
$resilienceScript = '<script>' . $this->resilienceScript() . '</script>';
$headInject = '<base href="' . htmlspecialchars($editorBaseHref, ENT_QUOTES) . '">' . $resilienceScript . $configScript;
if (preg_match('/<head[^>]*>/i', $html, $m, PREG_OFFSET_CAPTURE)) {
$pos = $m[0][1] + strlen($m[0][0]);
$html = substr($html, 0, $pos) . $headInject . substr($html, $pos);
}
$bridge = '<script>' . $this->bridgeScript() . '</script>';
$html = str_ireplace('</body>', $bridge . '</body>', $html);
$html = $this->editorHtml->prepare($html, $editorBaseHref);

$response = new DataDisplayResponse($html, Http::STATUS_OK, [
'Content-Type' => 'text/html; charset=utf-8',
Expand All @@ -252,159 +226,4 @@ public function iframe(): DataDisplayResponse|DataResponse {
return $response;
}

/**
* Resilience shim injected into the editor <head> before any editor
* script runs. The static eXeLearning editor's ResourceFetcher rejects
* on missing CSS / iDevice resources; under the php-wasm Playground
* those `files/perm/...` paths 404 (even though they ship in the bundle)
* and the unhandled rejection aborts the Yjs theme bind, leaving the
* page blank. mod_exelearning, wp-exelearning and omeka-s-exelearning
* all ship the same workaround:
*
* - swallow 404s on .css / idevices URLs (fetch + jQuery ajax) and
* return an empty stylesheet so the editor keeps booting;
* - neutralize preview-sw.js service-worker registration with a full
* ServiceWorkerRegistration-like stub (a bare `{scope:''}` makes the
* v4 editor throw on `reg.addEventListener` and aborts the hidden
* export iframe used for Web/SCORM/ePub export).
*/
private function resilienceScript(): string {
return <<<'JS'
(function () {
if ("serviceWorker" in navigator) {
try {
navigator.serviceWorker.register = function () {
return Promise.resolve({
scope: "", installing: null, waiting: null, active: null,
addEventListener: function () {}, removeEventListener: function () {},
update: function () { return Promise.resolve(); },
unregister: function () { return Promise.resolve(true); }
});
};
} catch (e) { void e; }
}

var originalFetch = window.fetch;
if (originalFetch) {
window.fetch = function (input, init) {
var url = typeof input === "string" ? input : (input && input.url) || "";
return originalFetch.apply(this, arguments).then(function (response) {
if (!response.ok && (url.indexOf(".css") !== -1 || url.indexOf("idevices") !== -1)) {
console.warn("[Nextcloud] Fetch 404 fallback:", url);
return new Response("/* empty fallback */", { status: 200, headers: { "Content-Type": "text/css" } });
}
return response;
}).catch(function (error) {
if (url.indexOf(".css") !== -1 || url.indexOf("idevices") !== -1) {
console.warn("[Nextcloud] Fetch error fallback:", url);
return new Response("/* empty fallback */", { status: 200, headers: { "Content-Type": "text/css" } });
}
throw error;
});
};
}

var patchJQuery = function ($) {
if (!$ || !$.ajaxTransport) return;
$.ajaxTransport("+*", function (options) {
var url = options.url || "";
if (!(url.indexOf(".css") !== -1 || url.indexOf("idevices") !== -1)) return;
return {
send: function (headers, completeCallback) {
var xhr = new XMLHttpRequest();
xhr.open(options.type || "GET", url, true);
xhr.onload = function () {
if (xhr.status >= 200 && xhr.status < 300) {
completeCallback(xhr.status, xhr.statusText, { text: xhr.responseText });
} else {
console.warn("[Nextcloud] jQuery 404 fallback:", url);
completeCallback(200, "OK", { text: "/* empty fallback */" });
}
};
xhr.onerror = function () {
console.warn("[Nextcloud] jQuery error fallback:", url);
completeCallback(200, "OK", { text: "/* empty fallback */" });
};
xhr.send();
},
abort: function () {}
};
});
};
if (window.jQuery) {
patchJQuery(window.jQuery);
} else {
try {
Object.defineProperty(window, "jQuery", {
configurable: true,
set: function (val) {
Object.defineProperty(window, "jQuery", {
configurable: true, writable: true, enumerable: true, value: val
});
patchJQuery(val);
},
get: function () { return undefined; }
});
} catch (e) { void e; }
}
})();
JS;
}

private function bridgeScript(): string {
return <<<'JS'
(() => {
const send = (msg) => { try { window.parent.postMessage(msg, '*'); } catch (e) { void e; } };
window.addEventListener('keydown', (event) => {
if ((event.ctrlKey || event.metaKey) && event.key.toLowerCase() === 's') {
event.preventDefault();
send({ type: 'REQUEST_SAVE', requestId: 'nextcloud-exelearning-shortcut-' + Date.now() });
}
}, true);

const waitForReady = () => new Promise((resolve) => {
const tick = () => {
const ready = window.eXeLearning && window.eXeLearning.ready;
if (ready && typeof ready.then === 'function') ready.then(resolve);
else setTimeout(tick, 50);
};
tick();
});
waitForReady().then(() => {
const bridge = window.eXeLearning && window.eXeLearning.app && window.eXeLearning.app.embeddingBridge;
if (!bridge) return;
bridge.handleSaveRequest = async function (requestId) {
const project = this.app.project;
const yjsBridge = project && project._yjsBridge;
const documentManager = yjsBridge && yjsBridge.documentManager;
if (!window.SharedExporters || !documentManager) {
throw new Error('Exporter unavailable');
}
if (typeof documentManager._updateVersionMetadata === 'function') {
try { await documentManager._updateVersionMetadata(); } catch (_e) { void _e; }
}
const exporter = window.SharedExporters.createExporter(
'elpx', documentManager,
yjsBridge.assetCache, yjsBridge.resourceFetcher, yjsBridge.assetManager
);
const result = await exporter.export({});
if (!result || !result.success || !result.data) {
throw new Error((result && result.error) || 'Export failed');
}
const data = result.data;
const bytes = data instanceof ArrayBuffer
? data
: (ArrayBuffer.isView(data)
? data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength)
: data);
this.postToParent({
type: 'SAVE_FILE', requestId,
bytes, filename: result.filename || 'project.elpx',
size: bytes.byteLength,
});
};
});
})();
JS;
}
}
180 changes: 180 additions & 0 deletions lib/Service/EditorHtmlService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
<?php

declare(strict_types=1);

namespace OCA\ExeLearning\Service;

/**
* Builds the HTML shell used to embed the static eXeLearning editor.
*/
class EditorHtmlService {
public function prepare(string $html, string $editorBaseHref): string {
$staticConfig = json_encode([
'hideUI' => (object)[
'fileMenu' => true,
'saveButton' => true,
'shareButton' => false,
'userMenu' => true,
'downloadButton' => false,
'helpMenu' => false,
],
], JSON_UNESCAPED_SLASHES);

$configScript = '<script>(function(){'
. 'var base=new URL(".",document.baseURI).href.replace(/\\/+$/,"");'
. 'var origin=window.location.origin;'
. 'window.__EXE_EMBEDDING_CONFIG__=Object.assign(' . $staticConfig . ','
. '{basePath:base,parentOrigin:origin,trustedOrigins:[origin]});'
. '})();</script>';

$resilienceScript = '<script>' . $this->resilienceScript() . '</script>';
$headInject = '<base href="' . htmlspecialchars($editorBaseHref, ENT_QUOTES) . '">' . $resilienceScript . $configScript;
if (preg_match('/<head[^>]*>/i', $html, $match, PREG_OFFSET_CAPTURE)) {
$position = $match[0][1] + strlen($match[0][0]);
$html = substr($html, 0, $position) . $headInject . substr($html, $position);
}

$bridge = '<script>' . $this->bridgeScript() . '</script>';
return str_ireplace('</body>', $bridge . '</body>', $html);
}

private function resilienceScript(): string {
return <<<'JS'
(function () {
if ("serviceWorker" in navigator) {
try {
navigator.serviceWorker.register = function () {
return Promise.resolve({
scope: "", installing: null, waiting: null, active: null,
addEventListener: function () {}, removeEventListener: function () {},
update: function () { return Promise.resolve(); },
unregister: function () { return Promise.resolve(true); }
});
};
} catch (e) { void e; }
}

var originalFetch = window.fetch;
if (originalFetch) {
window.fetch = function (input, init) {
var url = typeof input === "string" ? input : (input && input.url) || "";
return originalFetch.apply(this, arguments).then(function (response) {
if (!response.ok && (url.indexOf(".css") !== -1 || url.indexOf("idevices") !== -1)) {
console.warn("[Nextcloud] Fetch 404 fallback:", url);
return new Response("/* empty fallback */", { status: 200, headers: { "Content-Type": "text/css" } });
}
return response;
}).catch(function (error) {
if (url.indexOf(".css") !== -1 || url.indexOf("idevices") !== -1) {
console.warn("[Nextcloud] Fetch error fallback:", url);
return new Response("/* empty fallback */", { status: 200, headers: { "Content-Type": "text/css" } });
}
throw error;
});
};
}

var patchJQuery = function ($) {
if (!$ || !$.ajaxTransport) return;
$.ajaxTransport("+*", function (options) {
var url = options.url || "";
if (!(url.indexOf(".css") !== -1 || url.indexOf("idevices") !== -1)) return;
return {
send: function (headers, completeCallback) {
var xhr = new XMLHttpRequest();
xhr.open(options.type || "GET", url, true);
xhr.onload = function () {
if (xhr.status >= 200 && xhr.status < 300) {
completeCallback(xhr.status, xhr.statusText, { text: xhr.responseText });
} else {
console.warn("[Nextcloud] jQuery 404 fallback:", url);
completeCallback(200, "OK", { text: "/* empty fallback */" });
}
};
xhr.onerror = function () {
console.warn("[Nextcloud] jQuery error fallback:", url);
completeCallback(200, "OK", { text: "/* empty fallback */" });
};
xhr.send();
},
abort: function () {}
};
});
};
if (window.jQuery) {
patchJQuery(window.jQuery);
} else {
try {
Object.defineProperty(window, "jQuery", {
configurable: true,
set: function (val) {
Object.defineProperty(window, "jQuery", {
configurable: true, writable: true, enumerable: true, value: val
});
patchJQuery(val);
},
get: function () { return undefined; }
});
} catch (e) { void e; }
}
})();
JS;
}

private function bridgeScript(): string {
return <<<'JS'
(() => {
const send = (msg) => { try { window.parent.postMessage(msg, '*'); } catch (e) { void e; } };
window.addEventListener('keydown', (event) => {
if ((event.ctrlKey || event.metaKey) && event.key.toLowerCase() === 's') {
event.preventDefault();
send({ type: 'REQUEST_SAVE', requestId: 'nextcloud-exelearning-shortcut-' + Date.now() });
}
}, true);

const waitForReady = () => new Promise((resolve) => {
const tick = () => {
const ready = window.eXeLearning && window.eXeLearning.ready;
if (ready && typeof ready.then === 'function') ready.then(resolve);
else setTimeout(tick, 50);
};
tick();
});
waitForReady().then(() => {
const bridge = window.eXeLearning && window.eXeLearning.app && window.eXeLearning.app.embeddingBridge;
if (!bridge) return;
bridge.handleSaveRequest = async function (requestId) {
const project = this.app.project;
const yjsBridge = project && project._yjsBridge;
const documentManager = yjsBridge && yjsBridge.documentManager;
if (!window.SharedExporters || !documentManager) {
throw new Error('Exporter unavailable');
}
if (typeof documentManager._updateVersionMetadata === 'function') {
try { await documentManager._updateVersionMetadata(); } catch (_e) { void _e; }
}
const exporter = window.SharedExporters.createExporter(
'elpx', documentManager,
yjsBridge.assetCache, yjsBridge.resourceFetcher, yjsBridge.assetManager
);
const result = await exporter.export({});
if (!result || !result.success || !result.data) {
throw new Error((result && result.error) || 'Export failed');
}
const data = result.data;
const bytes = data instanceof ArrayBuffer
? data
: (ArrayBuffer.isView(data)
? data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength)
: data);
this.postToParent({
type: 'SAVE_FILE', requestId,
bytes, filename: result.filename || 'project.elpx',
size: bytes.byteLength,
});
};
});
})();
JS;
}
}
Loading
Loading