Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
77 changes: 53 additions & 24 deletions scripts/fetch-onnxruntime.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,18 @@ const VERSION = "1.27.1";
const SOURCE_COMMIT = "df2ba1cf8108aa63627cf4cdf8f807880b938616";
const BASE = `https://github.com/microsoft/onnxruntime/releases/download/v${VERSION}`;

/**
* Microsoft's own NuGet package of the same release, for every target it covers.
*
* github.com/microsoft/onnxruntime and its release assets have returned 404 since
* 2026-11-17, which failed every CI run at "Stage ONNX Runtime". The NuGet package is
* the same release, Microsoft-signed, and a NuGet version is immutable: once
* published, its bytes cannot be replaced, so the SHA-256 pin holds as it did for the
* GitHub assets. One package carries every runtime, so each entry names its member by
* path: `onnxruntime.dll` exists once per Windows arch inside it.
*/
const NUGET = `https://api.nuget.org/v3-flatcontainer/microsoft.ml.onnxruntime/${VERSION}/microsoft.ml.onnxruntime.${VERSION}.nupkg`;

/**
* Where a target's archive is fetched from. Upstream unless the entry overrides it.
*
Expand All @@ -88,10 +100,10 @@ const baseUrlFor = (spec) => spec.baseUrl ?? BASE;
* Per-target: the upstream artifact slug, its digest, and the library to lift out.
*
* `out` is not cosmetic — it is the exact name `ortLibName()` looks for in
* compositorViewService.ts. `member` is the file inside the archive, which on macOS
* and Linux is the VERSIONED real file rather than the unversioned symlink beside
* it: tar restores that symlink as a symlink, and a dangling one in the packaged app
* would resolve to nothing.
* compositorViewService.ts. `member` is the file inside the archive. In a tgz it is
* the VERSIONED real file rather than the unversioned symlink beside it: tar restores
* that symlink as a symlink, and a dangling one in the packaged app would resolve to
* nothing. The NuGet package is a zip, which holds no symlinks.
*
* darwin-x64 is absent and cannot be added: Microsoft publishes no `osx-x86_64`
* (or universal) asset for any release from 1.27 on — arm64 is the only macOS
Expand All @@ -103,15 +115,17 @@ const PINNED = {
"win32-x64": {
slug: "win-x64",
ext: "zip",
sha256: "2e00414a63fdef0914cd5a5ede6c707844878e0c08e1b6693842f0451b2df2a1",
member: "onnxruntime.dll",
sha256: "9359e46eba4482ded00e678c98f22b68f51bb411d7934f5516d64050edfa3383",
member: "runtimes/win-x64/native/onnxruntime.dll",
url: NUGET,
out: "onnxruntime.dll",
},
"win32-arm64": {
slug: "win-arm64",
ext: "zip",
sha256: "6e22c2061ba6400b42a59663d700c8694e4e8fe654cf452c4700c24237407ae1",
member: "onnxruntime.dll",
sha256: "9359e46eba4482ded00e678c98f22b68f51bb411d7934f5516d64050edfa3383",
member: "runtimes/win-arm64/native/onnxruntime.dll",
url: NUGET,
out: "onnxruntime.dll",
},
// The one target that does NOT come from upstream, and it is not a preference.
Expand Down Expand Up @@ -149,16 +163,18 @@ const PINNED = {
// See technical-documentation/engineering/webcam-segmentation-backend-port.md.
"linux-x64": {
slug: "linux-x64",
ext: "tgz",
sha256: "25b1ef1fea1acd210d63f8f24dc870ad6e077795ce1f54876252c6d3803c15af",
member: `libonnxruntime.so.${VERSION}`,
ext: "zip",
sha256: "9359e46eba4482ded00e678c98f22b68f51bb411d7934f5516d64050edfa3383",
member: "runtimes/linux-x64/native/libonnxruntime.so",
url: NUGET,
out: "libonnxruntime.so",
},
"linux-arm64": {
slug: "linux-aarch64",
ext: "tgz",
sha256: "33c67e33d1e25b816878366ea276589a024f71f000e7ff955c4b33224d639edd",
member: `libonnxruntime.so.${VERSION}`,
ext: "zip",
sha256: "9359e46eba4482ded00e678c98f22b68f51bb411d7934f5516d64050edfa3383",
member: "runtimes/linux-arm64/native/libonnxruntime.so",
url: NUGET,
out: "libonnxruntime.so",
},
};
Expand Down Expand Up @@ -186,10 +202,15 @@ function extract(archive, destDir) {
fs.mkdirSync(destDir, { recursive: true });
// Run from destDir with a bare filename: given an absolute Windows path, tar
// reads "C:\..." as host:path and tries to resolve a host called C.
const r = run(tarBin(), [archive.endsWith(".zip") ? "-xf" : "-xzf", path.basename(archive)], {
cwd: destDir,
});
if (r.status !== 0) throw new Error(`tar failed to extract ${path.basename(archive)}`);
// Windows' tar is bsdtar and reads zip; GNU tar on Linux does not.
const isZip = archive.endsWith(".zip");
const [cmd, args] =
isZip && process.platform !== "win32"
? ["unzip", ["-q"]]
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
: [tarBin(), [isZip ? "-xf" : "-xzf"]];
const r = run(cmd, [...args, path.basename(archive)], { cwd: destDir });
if (r.error) throw new Error(`${cmd} could not start: ${r.error.message}`);
if (r.status !== 0) throw new Error(`${cmd} failed to extract ${path.basename(archive)}`);
}

/** Depth-first search for a file by exact basename. */
Expand Down Expand Up @@ -254,7 +275,7 @@ async function download(spec) {
const asset = assetName(spec);
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), "openscreen-ort-"));
console.log(`Downloading ${asset}\n from v${VERSION}`);
const res = await fetch(`${baseUrlFor(spec)}/${asset}`);
const res = await fetch(spec.url ?? `${baseUrlFor(spec)}/${asset}`);
if (!res.ok) throw new Error(`Download failed: ${res.status} ${res.statusText}`);
const bytes = Buffer.from(await res.arrayBuffer());

Expand All @@ -269,9 +290,15 @@ async function download(spec) {
}
console.log(` sha256 ok (${(bytes.length / 1048576).toFixed(0)} MB)`);

const archive = path.join(tmp, asset);
fs.writeFileSync(archive, bytes);
extract(archive, tmp);
// The NuGet package is 135 MB: a failed extraction must not leave it behind.
try {
const archive = path.join(tmp, asset);
fs.writeFileSync(archive, bytes);
extract(archive, tmp);
} catch (e) {
fs.rmSync(tmp, { recursive: true, force: true });
throw e;
}
return tmp;
}

Expand Down Expand Up @@ -370,8 +397,10 @@ async function main() {

const tmp = await download(spec);
try {
const lib = find(tmp, spec.member);
if (!lib) throw new Error(`${spec.member} not found inside ${assetName(spec)}`);
// A path names the one member of a multi-runtime archive; a bare name is searched.
const lib = spec.member.includes("/") ? path.join(tmp, spec.member) : find(tmp, spec.member);
if (!lib || !fs.existsSync(lib))
throw new Error(`${spec.member} not found inside ${assetName(spec)}`);
const license = find(tmp, "LICENSE");
if (!license) throw new Error(`LICENSE not found inside ${assetName(spec)}`);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ A usable full package depends on generated artifacts that are not committed:
| Native D3D11 compositor addon | `electron/native/compositor-view/build/compositor_view.node` | Rust MSVC toolchain, Visual Studio/Windows SDK, LLVM/libclang, and the exact pinned shared FFmpeg SDK |
| Native Metal compositor addon | `electron/native/bin/darwin-<arch>/compositor_view.node` (plus a dev copy under `electron/native/compositor-view/build/`) | Rust, Xcode, and the LGPL FFmpeg tree from `fetch:ffmpeg:mac` |
| FFmpeg runtime files | matching `electron/native/bin/<platform>-<arch>/` directory | Downloaded by `fetch:ffmpeg` on Windows; **built from source** by `fetch:ffmpeg:mac` on macOS (~5 min) — BtbN publishes no macOS target and every circulating macOS build is GPL, which would relicense this MIT app |
| ONNX Runtime library | matching `electron/native/bin/<platform>-<arch>/` directory | Downloaded by `fetch:onnxruntime`: Microsoft's NuGet package on Windows and Linux, this repo's own build on macOS arm64. On Linux the package is a zip, so `unzip` must be installed |

Electron-builder copies only the matching `electron/native/bin/<platform>-<arch>/` directory into each package. On both Windows and macOS the compositor `.node` ships from inside that directory, beside the ffmpeg libraries it links against, and never travels through ASAR.

Expand Down
Loading