JR-021, JR-022, JR-023: File Transformation is a hard dependency
Deletes the on-disk index.html injection rather than leaving it switched off. Plugin.cs had already stopped calling it, but an unreachable write path with a live signature is the one a later refactor re-enables by accident, and it was still the behaviour the README and the release changelog advertised. Patching index.html on disk is destructive in ways a plugin cannot clean up after: the patch outlives an uninstall, a web-client upgrade discards it silently, and it races any other plugin touching the same file. It is also a second code path, and the one nobody runs is the one that rots. WebClientPatchService is now removal-only. The strip is factored out as RemoveInjection so it is testable without a filesystem. Removal is the one write JR-021 permits -- an earlier JRay did patch the file, and those users must not be left with a stale injection pointing at endpoints that have since changed. It keys on JRay's own marker, so it touches nothing another plugin added. JR-021 is a requirement to *not do* something, which no unit test can demonstrate, so scripts/checks/no-index-injection.sh verifies it by absence. The check was confirmed to fail on a reintroduced Apply() and on reintroduced ReplaceLast injection -- a check that has only ever passed is not evidence. Jellyfin has no plugin dependency mechanism, so nothing installs File Transformation for the user and a log warning alone is one nobody reads. GET /Plugins/JRay/Status/Dependencies reports whether the dependency is satisfied, and the configuration page renders it with the repository URL and what to do with it. Absent the plugin only the overlay is disabled; every other feature works. JR-022 and JR-023 stay In Progress rather than Done: neither has a test that executes, and this repo has no test project yet. TRACES: JR-021, JR-022, JR-023 | PR-004 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Executable
+44
@@ -0,0 +1,44 @@
|
||||
#!/usr/bin/env bash
|
||||
# JR-021 — jRay never injects into index.html on disk.
|
||||
#
|
||||
# This is a requirement to *not do* something, so it is verified by absence.
|
||||
# A unit test cannot show that no code path writes the tag; a grep can.
|
||||
#
|
||||
# The prohibition is on injection, not on writing: JR-022's migration must write
|
||||
# to index.html in order to remove a legacy patch. So the check is for code that
|
||||
# *adds* the script tag, not for File.Write* generally.
|
||||
#
|
||||
# TRACES: JR-021 | PR-004
|
||||
set -euo pipefail
|
||||
|
||||
cd "$(dirname "$0")/../.."
|
||||
src="Jellyfin.Plugin.JRay"
|
||||
status=0
|
||||
|
||||
# The injection is "script tag + marker" written back to the file. The removal
|
||||
# path also names both, so match on the concatenation that builds a patched
|
||||
# document rather than on the constants themselves.
|
||||
if grep -rn --include='*.cs' -E '(ScriptTag|Injected)[[:space:]]*\+.*BodyClose|ReplaceLast|"</body>"[[:space:]]*,' "$src" \
|
||||
| grep -v 'FileTransformationRegistration.cs'; then
|
||||
echo "FAIL (JR-021): index.html injection logic found outside the File Transformation callback." >&2
|
||||
status=1
|
||||
fi
|
||||
|
||||
# WebClientPatchService is removal-only. Any write there must be the cleaned
|
||||
# document; a write of a *patched* one is the regression this guards.
|
||||
if grep -n -E 'WriteAllText\((?!.*cleaned)' -P "$src/Services/WebClientPatchService.cs" >/dev/null 2>&1; then
|
||||
echo "FAIL (JR-021): WebClientPatchService writes something other than the cleaned document." >&2
|
||||
status=1
|
||||
fi
|
||||
|
||||
# The disk-patching entry point must not come back.
|
||||
if grep -rn --include='*.cs' -E '\bWebClientPatchService\.Apply\b' "$src"; then
|
||||
echo "FAIL (JR-021): the injecting Apply() entry point has been reintroduced." >&2
|
||||
status=1
|
||||
fi
|
||||
|
||||
if [ "$status" -eq 0 ]; then
|
||||
echo "OK (JR-021): no on-disk injection path."
|
||||
fi
|
||||
|
||||
exit "$status"
|
||||
Reference in New Issue
Block a user