import * as child_process from 'child_process';
import * as crypto from 'crypto';
import * as fs from 'fs/promises';
import * as os from 'os';
import * as path from 'path';
import * as url from 'url';
const args = process.argv.slice(2);
const read = (match) => {
if (args.length > 0 && (!match || args[0] === match)) {
return args.shift();
}
return null;
};
let configuration = null;
const dirname = (...args) => {
const file = url.fileURLToPath(import.meta.url);
const dir = path.dirname(file);
return path.join(dir, ...args);
};
const load = async () => {
const file = dirname('package.json');
const content = await fs.readFile(file, 'utf-8');
configuration = JSON.parse(content);
};
const clearLine = () => {
if (process.stdout.clearLine) {
process.stdout.clearLine();
}
};
const write = (message) => {
if (process.stdout.write) {
process.stdout.write(message);
}
};
const writeLine = (message) => {
write(message + os.EOL);
};
const access = async (path) => {
try {
await fs.access(path);
return true;
} catch {
return false;
}
};
const rm = async (...args) => {
const dir = dirname(...args);
const exists = await access(dir);
if (exists) {
const paths = path.join(...args);
writeLine(`rm ${paths}`);
const options = { recursive: true, force: true };
await fs.rm(dir, options);
}
};
const mkdir = async (...args) => {
const dir = dirname(...args);
const exists = await access(dir);
if (!exists) {
const paths = path.join(...args);
writeLine(`mkdir ${paths}`);
const options = { recursive: true };
await fs.mkdir(dir, options);
}
return dir;
};
const copy = async (source, target, filter) => {
let files = await fs.readdir(source);
files = filter ? files.filter((file) => filter(file)) : files;
const promises = files.map((file) => fs.copyFile(path.join(source, file), path.join(target, file)));
await Promise.all(promises);
};
const unlink = async (dir, filter) => {
let files = await fs.readdir(dir);
files = filter ? files.filter((file) => filter(file)) : files;
const promises = files.map((file) => fs.unlink(path.join(dir, file)));
await Promise.all(promises);
};
const exec = async (command, encoding, cwd) => {
cwd = cwd || dirname();
if (encoding) {
return child_process.spawnSync(command, { shell: true, cwd, encoding });
}
child_process.execSync(command, { cwd, stdio: [0,1,2] });
return '';
};
const sleep = (delay) => {
return new Promise((resolve) => {
global.setTimeout(resolve, delay);
});
};
const request = async (url, init, status) => {
const response = await global.fetch(url, init);
if (status !== false && !response.ok) {
throw new Error(`${response.status.toString()} ${response.statusText}`);
}
if (response.body) {
const reader = response.body.getReader();
let position = 0;
const stream = new global.ReadableStream({
start(controller) {
const read = async () => {
try {
const result = await reader.read();
if (result.done) {
clearLine();
controller.close();
} else {
position += result.value.length;
write(` ${position} bytes\r`);
controller.enqueue(result.value);
read();
}
} catch (error) {
controller.error(error);
}
};
read();
}
});
return new global.Response(stream, {
status: response.status,
statusText: response.statusText,
headers: response.headers
});
}
return response;
};
const download = async (url) => {
writeLine(`download ${url}`);
const response = await request(url);
return response.arrayBuffer().then((buffer) => new Uint8Array(buffer));
};
const hash = async (url, algorithm) => {
const data = await download(url);
const hash = crypto.createHash(algorithm);
hash.update(data);
return hash.digest('hex');
};
const fork = async (organization, repository) => {
const headers = {
Authorization: `Bearer ${process.env.GITHUB_TOKEN}`
};
writeLine(`github delete ${repository}`);
await request(`https://api.github.com/repos/${process.env.GITHUB_USER}/${repository}`, {
method: 'DELETE',
headers
}, false);
await sleep(4000);
writeLine(`github fork ${repository}`);
await request(`https://api.github.com/repos/${organization}/${repository}/forks`, {
method: 'POST',
headers,
body: ''
});
await sleep(4000);
await rm('dist', repository);
writeLine(`github clone ${repository}`);
await exec(`git clone --depth=2 https://x-access-token:${process.env.GITHUB_TOKEN}@github.com/${process.env.GITHUB_USER}/${repository}.git dist/${repository}`);
};
const pullrequest = async (organization, repository, token, body) => {
writeLine(`github push ${repository}`);
await exec(`git -C dist/${repository} push`);
writeLine(`github pullrequest ${repository}`);
const headers = {
Authorization: `Bearer ${token}`
};
await request(`https://api.github.com/repos/${organization}/${repository}/pulls`, {
method: 'POST',
headers,
body: JSON.stringify(body)
});
};
const clean = async () => {
await rm('dist');
await rm('node_modules');
await rm('package-lock.json');
await rm('yarn.lock');
if (read('purge')) {
await rm('third_party');
}
};
const install = async () => {
const node_modules = dirname('node_modules');
let exists = await access(node_modules);
if (exists) {
const dependencies = { ...configuration.dependencies, ...configuration.devDependencies };
const matches = await Promise.all(Object.entries(dependencies).map(async ([name, version]) => {
const file = path.join('node_modules', name, 'package.json');
const exists = await access(file);
if (exists) {
const content = await fs.readFile(file, 'utf8');
const obj = JSON.parse(content);
return obj.version === version;
}
return false;
}));
exists = matches.every((match) => match);
if (!exists) {
await clean();
}
}
exists = await access(node_modules);
if (!exists) {
await exec('npm install');
}
try {
await exec('python --version', 'utf-8');
await exec('python -m pip install --upgrade --quiet setuptools ruff');
} catch {
// continue regardless of error
}
};
const start = async () => {
await install();
await exec('npx electron .');
};
const build = async (target) => {
switch (target || read()) {
case 'web': {
writeLine('build web');
await rm('dist', 'web');
await mkdir('dist', 'web');
writeLine('cp source/dir dist/dir');
const source_dir = dirname('source');
const dist_dir = dirname('dist', 'web');
const extensions = new Set(['html', 'css', 'js', 'json', 'ico', 'png']);
await copy(source_dir, dist_dir, (file) => extensions.has(file.split('.').pop()));
await rm('dist', 'web', 'app.js');
await rm('dist', 'web', 'node.js');
await rm('dist', 'web', 'desktop.mjs');
const contentFile = dirname('dist', 'web', 'index.html');
let content = await fs.readFile(contentFile, 'utf-8');
content = content.replace(/()/m, (match, p1, p2, p3) => {
return p1 + configuration.version + p3;
});
content = content.replace(/()/m, (match, p1, p2, p3) => {
return p1 + configuration.date + p3;
});
await fs.writeFile(contentFile, content, 'utf-8');
break;
}
case 'electron': {
const key = read();
const target = key ? `electron ${key}` : 'electron';
writeLine(`build ${target}`);
await install();
await exec('npx electron-builder install-app-deps');
const table = new Map([
['mac', 'npx electron-builder --mac --universal --publish never --config.mac.identity=null'],
['windows', 'npx electron-builder --win --x64 --arm64 --publish never --config.win.azureSignOptions='],
['linux', 'npx electron-builder --linux --publish never']
]);
const targets = table.has(key) ? [table.get(key)] : Array.from(table.values());
for (const target of targets) {
/* eslint-disable no-await-in-loop */
await exec(target);
/* eslint-enable no-await-in-loop */
}
break;
}
case 'python': {
writeLine('build python');
await exec('python package.py build version');
await exec('python -m pip install --user build wheel --quiet');
await exec('python -m build --wheel --outdir dist/pypi dist/pypi');
if (read('install')) {
await exec('python -m pip install --force-reinstall dist/pypi/*.whl');
}
break;
}
default: {
writeLine('build');
await rm('dist');
await install();
await build('web');
await build('electron');
await build('python');
break;
}
}
};
const publish = async (target) => {
const GITHUB_TOKEN = process.env.GITHUB_TOKEN;
const GITHUB_USER = process.env.GITHUB_USER;
switch (target || read()) {
case 'web': {
writeLine('publish web');
await build('web');
await rm('dist', 'gh-pages');
const url = `https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_USER}/netron.git`;
await exec(`git clone --depth=1 ${url} --branch gh-pages ./dist/gh-pages 2>&1 > /dev/null`);
writeLine('cp dist/web dist/gh-pages');
const source_dir = dirname('dist', 'web');
const target_dir = dirname('dist', 'gh-pages');
await unlink(target_dir, (file) => file !== '.git');
await copy(source_dir, target_dir);
await exec('git -C dist/gh-pages add --all');
await exec('git -C dist/gh-pages commit --amend --no-edit');
await exec('git -C dist/gh-pages push --force origin gh-pages');
break;
}
case 'electron': {
const key = read();
const target = key ? ` ${key}` : '';
writeLine(`publish electron ${target}`);
await install();
await exec('npx electron-builder install-app-deps');
const table = new Map([
['mac', 'npx electron-builder --mac --universal --publish always'],
['windows', 'npx electron-builder --win --x64 --arm64 --publish always'],
['linux', 'npx electron-builder --linux --publish always']
]);
const targets = table.has(key) ? [table.get(key)] : Array.from(table.values());
for (const target of targets) {
/* eslint-disable no-await-in-loop */
await exec(target);
/* eslint-enable no-await-in-loop */
}
break;
}
case 'python': {
writeLine('publish python');
await build('python');
await exec('python -m pip install --user twine');
await exec('python -m twine upload --non-interactive --skip-existing --verbose dist/pypi/*.whl');
break;
}
case 'cask': {
writeLine('publish cask');
await fork('Homebrew', 'homebrew-cask');
const repository = `https://github.com/${configuration.repository}`;
const url = `${repository}/releases/download/v#{version}/${configuration.productName}-#{version}-mac.zip`;
const sha256 = await hash(url.replace(/#{version}/g, configuration.version), 'sha256');
writeLine('update manifest');
const dir = await mkdir('dist', 'homebrew-cask', 'Casks', 'n');
const file = path.join(dir, 'netron.rb');
await fs.writeFile(file, [
`cask "${configuration.name}" do`,
` version "${configuration.version}"`,
` sha256 "${sha256.toLowerCase()}"`,
'',
` url "${url}"`,
` name "${configuration.productName}"`,
` desc "${configuration.description.replace('Visualizer', 'Visualiser')}"`,
` homepage "${repository}"`,
'',
' auto_updates true',
'',
` app "${configuration.productName}.app"`,
'',
' zap trash: [',
` "~/Library/Application Support/${configuration.productName}",`,
` "~/Library/Preferences/${configuration.build.appId}.plist",`,
` "~/Library/Saved Application State/${configuration.build.appId}.savedState",`,
' ]',
'end',
''
].join('\n'));
writeLine('git push homebrew-cask');
await exec('git -C dist/homebrew-cask add --all');
await exec(`git -C dist/homebrew-cask commit -m "${configuration.name} ${configuration.version}"`);
await pullrequest('Homebrew', 'homebrew-cask', process.env.GITHUB_TOKEN, {
title: `${configuration.name} ${configuration.version}`,
body: 'Update version and sha256',
head: `${process.env.GITHUB_USER}:master`,
base: 'master'
});
await rm('dist', 'homebrew-cask');
break;
}
case 'winget': {
writeLine('publish winget');
await fork('microsoft', 'winget-pkgs');
const name = configuration.name;
const version = configuration.version;
const product = configuration.productName;
const publisher = configuration.author.name;
const identifier = `${publisher.replace(' ', '')}.${product}`;
const copyright = `Copyright (c) ${publisher}`;
const repository = `https://github.com/${configuration.repository}`;
const url = `${repository}/releases/download/v${version}/${product}-Setup-${version}.exe`;
const content = await fs.readFile(configuration.build.extends, 'utf-8');
const builder = JSON.parse(content);
const extensions = builder.fileAssociations.map((entry) => `- ${entry.ext}`).sort().join('\n');
const sha256 = await hash(url, 'sha256');
const paths = ['dist', 'winget-pkgs', 'manifests', publisher[0].toLowerCase(), publisher.replace(' ', ''), product, version];
await mkdir(...paths);
writeLine('update manifest');
const manifestFile = dirname(...paths, identifier);
await fs.writeFile(`${manifestFile}.yaml`, [
'# yaml-language-server: $schema=https://aka.ms/winget-manifest.version.1.6.0.schema.json',
`PackageIdentifier: ${identifier}`,
`PackageVersion: ${version}`,
'DefaultLocale: en-US',
'ManifestType: version',
'ManifestVersion: 1.6.0',
''
].join('\n'));
await fs.writeFile(`${manifestFile}.installer.yaml`, [
'# yaml-language-server: $schema=https://aka.ms/winget-manifest.installer.1.6.0.schema.json',
`PackageIdentifier: ${identifier}`,
`PackageVersion: ${version}`,
'Platform:',
'- Windows.Desktop',
'InstallModes:',
'- silent',
'- silentWithProgress',
'Installers:',
'- Architecture: x86',
' Scope: user',
' InstallerType: nullsoft',
` InstallerUrl: ${url}`,
` InstallerSha256: ${sha256.toUpperCase()}`,
' InstallerLocale: en-US',
' InstallerSwitches:',
' Custom: /NORESTART',
' UpgradeBehavior: install',
'- Architecture: arm64',
' Scope: user',
' InstallerType: nullsoft',
` InstallerUrl: ${url}`,
` InstallerSha256: ${sha256.toUpperCase()}`,
' InstallerLocale: en-US',
' InstallerSwitches:',
' Custom: /NORESTART',
' UpgradeBehavior: install',
'FileExtensions:',
extensions,
'ManifestType: installer',
'ManifestVersion: 1.6.0',
''
].join('\n'));
await fs.writeFile(`${manifestFile}.locale.en-US.yaml`, [
'# yaml-language-server: $schema=https://aka.ms/winget-manifest.defaultLocale.1.6.0.schema.json',
`PackageIdentifier: ${identifier}`,
`PackageVersion: ${version}`,
`PackageName: ${product}`,
'PackageLocale: en-US',
`PackageUrl: ${repository}`,
`Publisher: ${publisher}`,
`PublisherUrl: ${repository}`,
`PublisherSupportUrl: ${repository}/issues`,
`Author: ${publisher}`,
`License: ${configuration.license}`,
`Copyright: ${copyright}`,
`CopyrightUrl: ${repository}/blob/main/LICENSE`,
`ShortDescription: ${configuration.description}`,
`Description: ${configuration.description}`,
`Moniker: ${name}`,
'Tags:',
'- machine-learning',
'- deep-learning',
'- neural-network',
'ManifestType: defaultLocale',
'ManifestVersion: 1.6.0',
''
].join('\n'));
writeLine('git push winget-pkgs');
await exec('git -C dist/winget-pkgs add --all');
await exec(`git -C dist/winget-pkgs commit -m "Update ${configuration.name} to ${configuration.version}"`);
await pullrequest('microsoft', 'winget-pkgs', process.env.WINGET_TOKEN, {
title: `Update ${configuration.productName} to ${configuration.version}`,
body: '',
head: `${process.env.GITHUB_USER}:master`,
base: 'master'
});
await rm('dist', 'winget-pkgs');
break;
}
default: {
writeLine('publish');
await rm('dist');
await install();
await publish('web');
await publish('electron');
await publish('python');
await publish('cask');
await publish('winget');
break;
}
}
};
const lint = async () => {
await install();
writeLine('eslint');
await exec('npx eslint --cache --cache-location ./dist/lint/.eslintcache');
writeLine('ruff');
await exec('python -m ruff check . --quiet');
};
const test = async (target) => {
let models = true;
while (true) {
/* eslint-disable no-await-in-loop */
if (target === 'desktop' || read('desktop')) {
target = null;
models = false;
await exec('npx playwright install --with-deps');
const host = process.platform === 'linux' && (process.env.GITHUB_ACTIONS || process.env.CI) ? 'xvfb-run -a ' : '';
await exec(`${host}npx playwright test --config=test/playwright.config.js --project=desktop`);
continue;
}
if (target === 'browser' || read('browser')) {
target = null;
models = false;
if (process.platform !== 'win32') {
await exec('npx playwright install --with-deps');
const headed = process.env.GITHUB_ACTIONS || process.env.CI ? '' : ' --headed';
await exec(`npx playwright test --config=test/playwright.config.js --project=browser${headed}`);
}
continue;
}
break;
/* eslint-enable no-await-in-loop */
}
if (models) {
target = target || args.join(' ');
await exec(`node test/models.js ${target}`);
}
};
const validate = async () => {
writeLine('lint');
await lint();
writeLine('test');
await test('tag:validation');
writeLine('test desktop');
await test('desktop');
writeLine('test browser');
await test('browser');
};
const update = async () => {
const filter = new Set(process.argv.length > 3 ? process.argv.slice(3) : []);
if (filter.size === 0) {
const output = await exec('npm outdated --json', 'utf-8');
const entries = JSON.parse(output.stdout);
const compare = (a, b) => {
const regex = /^\d+\.\d+\.\d+$/;
if (!regex.test(a)) {
throw new Error(`Invalid version format '${a}'.`);
}
if (!regex.test(b)) {
throw new Error(`Invalid version format '${b}'.`);
}
a = a.split('.').map((v) => Number(v));
b = b.split('.').map((v) => Number(v));
if (a.length !== b.length) {
throw new Error(`Invalid version a=${a.join('.')} b=${b.join('.')}`);
}
for (let i = 0; i < 3; i++) {
if ((a[i] || 0) > (b[i] || 0)) {
return 1;
}
if ((a[i] || 0) < (b[i] || 0)) {
return -1;
}
}
return 0;
};
for (const [name, entry] of Object.entries(entries)) {
if (compare(entry.wanted, entry.latest) < 0) {
writeLine(name);
/* eslint-disable no-await-in-loop */
await exec(`npm install --quiet --no-progress --silent --save-exact ${name}@latest`);
/* eslint-enable no-await-in-loop */
}
}
}
let targets = [
'armnn',
'bigdl',
'caffe', 'circle', 'cntk', 'coreml',
'dlc', 'dnn',
'executorch',
'gguf',
'kann', 'keras',
'mlir', 'mnn', 'mslite', 'megengine',
'nnabla',
'onnx', 'om',
'paddle', 'pytorch',
'rknn',
'sentencepiece', 'sklearn',
'tf',
'uff',
'xmodel'
];
let commands = [
'sync',
'install',
'schema',
'metadata'
];
if (filter.size > 0 && targets.some((target) => filter.has(target))) {
targets = targets.filter((target) => filter.has(target));
}
if (filter.size > 0 && commands.some((target) => filter.has(target))) {
commands = commands.filter((command) => filter.has(command));
}
commands = commands.join(' ');
for (const target of targets) {
/* eslint-disable no-await-in-loop */
await exec(`tools/${target} ${commands}`);
/* eslint-enable no-await-in-loop */
}
};
const pull = async () => {
await exec('git fetch --prune origin "refs/tags/*:refs/tags/*"');
let before = await exec('git rev-parse HEAD', 'utf-8');
if (before.status !== 0) {
throw new Error(before.stderr.trim());
}
try {
await exec('git pull --prune --rebase --autostash');
} catch (error) {
writeLine(error.message);
}
let after = await exec('git rev-parse HEAD', 'utf-8');
if (after.status !== 0) {
throw new Error(after.stderr.trim());
}
before = before.stdout.trim();
after = after.stdout.trim();
if (before !== after) {
const output = await exec(`git diff --name-only ${before} ${after}`, 'utf-8');
const files = new Set(output.stdout.split('\n'));
if (files.has('package.json')) {
await clean();
await install();
}
}
};
const coverage = async () => {
switch (read()) {
case 'desktop': {
await rm('dist', 'nyc');
await mkdir('dist', 'nyc');
await exec('cp package.json dist/nyc');
await exec('cp -R source dist/nyc');
await exec('nyc instrument --compact false source dist/nyc/source');
const file = dirname('dist', 'nyc', 'source', 'index.html');
let content = await fs.readFile(file, 'utf-8');
content = content.replace(`"script-src 'self'"`, `"script-src 'self' 'unsafe-eval'"`);
await fs.writeFile(file, content, 'utf-8');
await exec('nyc --instrument npx electron ./dist/nyc');
await exec('nyc report');
break;
}
case 'test': {
const target = args.join(' ');
await rm('dist', 'c8');
await exec(`npx c8 --reporter=html --report-dir=dist/c8/report node test/models.js ${target}`);
break;
}
default: {
throw new Error('Unsupported coverage target.');
}
}
};
const analyze = async () => {
const exists = await access('third_party/tools/codeql');
if (!exists) {
await exec('git clone --depth=1 https://github.com/github/codeql.git third_party/tools/codeql');
}
await rm('dist', 'codeql');
await mkdir('dist', 'codeql', 'netron');
await exec('cp -r publish source test tools dist/codeql/netron/');
await exec('codeql database create dist/codeql/database --source-root dist/codeql/netron --language=javascript --threads=3');
await exec('codeql database analyze dist/codeql/database ./third_party/tools/codeql/javascript/ql/src/codeql-suites/javascript-security-and-quality.qls --format=csv --output=dist/codeql/results.csv --threads=3');
await exec('cat dist/codeql/results.csv');
};
const version = async () => {
await pull();
const file = dirname('package.json');
let content = await fs.readFile(file, 'utf-8');
content = content.replace(/(\s*"version":\s")(\d\.\d\.\d)(",)/m, (match, p1, p2, p3) => {
const version = Array.from((parseInt(p2.split('.').join(''), 10) + 1).toString()).join('.');
return p1 + version + p3;
});
content = content.replace(/(\s*"date":\s")(.*)(",)/m, (match, p1, p2, p3) => {
const date = new Date().toISOString().split('.').shift().split('T').join(' ');
return p1 + date + p3;
});
await fs.writeFile(file, content, 'utf-8');
await exec('npm install --package-lock-only');
await load();
await exec('git add package.json');
await exec('git add package-lock.json');
await exec(`git commit -m "Update to ${configuration.version}"`);
await exec(`git tag v${configuration.version}`);
await exec('git push');
await exec('git push --tags');
};
const main = async () => {
await load();
try {
const task = read();
switch (task) {
case 'start': await start(); break;
case 'clean': await clean(); break;
case 'install': await install(); break;
case 'build': await build(); break;
case 'publish': await publish(); break;
case 'version': await version(); break;
case 'lint': await lint(); break;
case 'test': await test(); break;
case 'validate': await validate(); break;
case 'update': await update(); break;
case 'pull': await pull(); break;
case 'analyze': await analyze(); break;
case 'coverage': await coverage(); break;
default: throw new Error(`Unsupported task '${task}'.`);
}
} catch (error) {
if (process.stdout.write) {
process.stdout.write(error.message + os.EOL);
}
process.exit(1);
}
};
await main();