mirror of
https://github.com/storytold/effectcraft.git
synced 2026-11-06 02:20:50 +00:00
* G8: plug-in library Community Plug-in Library for WebAssembly effect plug-ins (#376): one reviewed catalog (index.json), install / update / remove from Settings > Plug-in Library (also Effect > Plug-in Library...), library.* commands, start-up loading of installed packages with SHA-256 checks. Downloads go through the system curl (https, GitHub hosts), as trained models do. Preview before installing (library.preview): the release is downloaded, checked like an install, and rendered in the sandbox on a built-in sample frame at default settings (2 s at 12 fps) with a Before/After split, plus the effect's parameters, "Open on GitHub" and an optional author video link (catalog field preview.video). Authors need to do nothing for it. Hardening: a module that fails to load leaves the installed copy alone, Update All updates every package in one job, minApp also applies to an explicit version, curl ignores ~/.curlrc and URL globbing, unique temp files, percent-decoded file URLs. Plug-in effect slots grow from 64 to 256 with a clearer overflow error. Docs: plugins.md "Plug-in Library", publishing-plugins.md (author guide from zero to listed), gaps.md; examples/plugin-catalog is the starting content of the catalog repository (schema, validation workflow). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * contributors: credit iseemhlyfta * G8: plug-in library: doc comments on the library's functions Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: plug-in catalog check: require one object with schema 1 and a packages array An empty file or several JSON values passed jq empty, and with SKIP_SCHEMA=1 nothing else checked the catalog's shape. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: plug-in library: one preview texture set; catalog schema requires effects The preview kept a texture set per package version previewed (about 6 MB each) for the whole session; it now keeps one, replaced when another package is previewed. Releases in the catalog schema must list at least one effect id, as the author guide says. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: plug-in catalog schema: effect ids follow the manifest's id rules Letters, digits, '.', '_' and '-', and not the reserved 'ec.' prefix, so library.missing can match them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: refuse Plug-in Library jobs while automation file access is confined Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: split the Plug-in Library page into toolbar, card, links and actions Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: show Plug-in Library toasts without a Roto job; cache preview frame checks Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: log Plug-in Library packages that fail to load at start-up Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: check an update before replacing a loaded package; Update All past failures - An update to a package that is already loaded is now compiled and its manifest checked (through the previewer, without registering it) before the new file is written and the old version's folder deleted. Before, a release with the right SHA-256 that didn't load replaced the working version and failed at the next start. - Package ids that differ only in case, or end in a dot, would share one folder on Windows and macOS: the catalog keeps the first of them, and ids can't end in a dot (schema too). - Update All: a package that can't be picked or installed no longer stops the others; the result names what was updated and what wasn't. - Downloads: at most 5 redirects, and one that ends off GitHub's hosts is refused, as the module docs say. - A job that panics no longer leaves the library busy; poisoned status locks are used, not dropped. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * G8: rustfmt the update test Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: FredApps <153173854+FredApps@users.noreply.github.com>
75 lines
3.5 KiB
Bash
75 lines
3.5 KiB
Bash
#!/usr/bin/env bash
|
|
# Validate the plug-in catalog: schema, unique ids, every release's download (size + SHA-256),
|
|
# then install every package with the real EffectCraft loader.
|
|
#
|
|
# scripts/validate.sh [index.json]
|
|
#
|
|
# Needs bash, jq, curl, sha256sum and npx (Node). Environment:
|
|
# EFFECTCRAFT_CLI path to an effectcraft-cli build; unset: the loader step is skipped.
|
|
# SKIP_SCHEMA=1 skip the schema step (testing with a local catalog that names file:// URLs).
|
|
set -euo pipefail
|
|
|
|
here=$(cd "$(dirname "$0")/.." && pwd)
|
|
catalog=${1:-$here/index.json}
|
|
work=$(mktemp -d)
|
|
trap 'rm -rf "$work"' EXIT
|
|
|
|
fail() { echo "error: $*" >&2; exit 1; }
|
|
# A path as the CLI sees it (Git Bash on Windows: /tmp/x -> C:/.../x).
|
|
native() { if command -v cygpath >/dev/null; then cygpath -m "$1"; else printf %s "$1"; fi; }
|
|
# A file:// URL for a local path (file:///C:/x or file:///tmp/x).
|
|
file_url() {
|
|
local p
|
|
p=$(native "$1")
|
|
[[ $p == /* ]] || p="/$p"
|
|
printf 'file://%s' "$p"
|
|
}
|
|
|
|
echo "== 1. schema"
|
|
[ "$(wc -c <"$catalog")" -le $((4 << 20)) ] || fail "the catalog is larger than 4 MB (the app's limit)"
|
|
# Exactly one object of format 1 with a packages array (an empty file or a second value fails too),
|
|
# checked even when the schema step is skipped.
|
|
jq -e -s 'length == 1 and (.[0] | type == "object" and .schema == 1 and (.packages | type == "array"))' "$catalog" >/dev/null \
|
|
|| fail "$catalog isn't one JSON object with \"schema\": 1 and a \"packages\" array"
|
|
if [ "${SKIP_SCHEMA:-}" = 1 ]; then
|
|
echo "skipped (SKIP_SCHEMA=1)"
|
|
else
|
|
npx --yes ajv-cli@5.0.0 validate --spec=draft2020 --strict=false -s "$here/schema.json" -d "$catalog"
|
|
fi
|
|
|
|
echo "== 2. unique ids"
|
|
dups=$(jq -r '.packages[].id' "$catalog" | sort | uniq -d)
|
|
[ -z "$dups" ] || fail "duplicate package ids: $dups"
|
|
echo "ok"
|
|
|
|
echo "== 3. downloads"
|
|
# The checked files are what the loader step installs: a copy of the catalog names them by file://.
|
|
local_catalog=$(jq '.' "$catalog")
|
|
while IFS=$'\t' read -r p r id version url sha size; do
|
|
file="$work/$id-$version.wasm"
|
|
echo "$id $version: $url"
|
|
curl -fsSL --retry 2 --max-filesize $((64 << 20)) -o "$file" "$url" || fail "$id $version: download failed"
|
|
got_size=$(wc -c <"$file" | tr -d ' ')
|
|
got_sha=$(sha256sum "$file" | cut -d' ' -f1)
|
|
[ -z "$size" ] || [ "$size" = "$got_size" ] || fail "$id $version: size is $got_size, the catalog says $size"
|
|
[ "$got_sha" = "$(tr 'A-F' 'a-f' <<<"$sha")" ] || fail "$id $version: SHA-256 is $got_sha, the catalog says $sha"
|
|
local_catalog=$(jq --argjson p "$p" --argjson r "$r" --arg u "$(file_url "$file")" '.packages[$p].versions[$r].url = $u' <<<"$local_catalog")
|
|
done < <(jq -r '.packages | to_entries[] | .key as $p | .value as $pkg | $pkg.versions | to_entries[]
|
|
| [$p, .key, $pkg.id, .value.version, .value.url, .value.sha256, (.value.size // "")] | @tsv' "$catalog")
|
|
echo "ok"
|
|
|
|
echo "== 4. load with EffectCraft"
|
|
if [ -z "${EFFECTCRAFT_CLI:-}" ]; then
|
|
echo "skipped (set EFFECTCRAFT_CLI to an effectcraft-cli build)"
|
|
exit 0
|
|
fi
|
|
printf '%s\n' "$local_catalog" >"$work/index.json"
|
|
mkdir -p "$work/config"
|
|
export EFFECTCRAFT_CONFIG_DIR=$(native "$work/config")
|
|
"$EFFECTCRAFT_CLI" exec library.refresh "{\"catalog\": \"$(file_url "$work/index.json")\", \"wait\": true}"
|
|
# shortcut: installs each package's newest release this build runs, not every release; older releases were checked when they were added.
|
|
for id in $(jq -r '.packages[].id' "$catalog"); do
|
|
"$EFFECTCRAFT_CLI" exec library.install "{\"id\": \"$id\", \"wait\": true}" || fail "$id didn't install"
|
|
done
|
|
echo "ok"
|